conventional-changelog / conventional-changelog

Generate changelogs and release notes from a project's commit messages and metadata.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Unclear about default setup of conventional-changelog-conventionalcommits package

amimas opened this issue · comments

commented

I'm new to this package and having hard time understanding some of the default setups. I started with semantic-release for automating a release process in a project.

The commit-analyzer package is part of semantic-release. From there, I came across conventionalcommits preset. I believe that preset comes from this repo.

In the link above, you can see the usage example shows additional configs releaseRules, parserOpts:

{
  "plugins": [
    ["@semantic-release/commit-analyzer", {
      "preset": "angular",
      "releaseRules": [
        {"type": "docs", "scope":"README", "release": "patch"},
        {"type": "refactor", "release": "patch"},
        {"type": "style", "release": "patch"}
      ],
      "parserOpts": {
        "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"]
      }
    }],
    "@semantic-release/release-notes-generator"
  ]
}

What's not clear to me is whether I need those additional configs when I use conventionalcommits preset.

In addition, there is following note:

Note: For presets that expects a configuration object, such as conventionalcommits, the presetConfig option must be set.

I'm not sure what to configure in presetConfig option as it's not documented in the Readme.

Could you please help clarify the usage?