Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: improve documentation of 'config' option #262

Open
BinToss opened this issue Sep 12, 2021 · 0 comments
Open

docs: improve documentation of 'config' option #262

BinToss opened this issue Sep 12, 2021 · 0 comments

Comments

@BinToss
Copy link

BinToss commented Sep 12, 2021

https://github.com/semantic-release/commit-analyzer#options

npm package name of a custom conventional-changelog preset.
i.e "conventional-changelog-conventionalcommits"?

  • Am I correct in understanding this 'name' would be the same value as used in the following example?
    npm install $name
  • Does the 'config' option require additional configuration like the 'preset' option may require the 'presetConfig' option depending on its value?
  • Does it expose options/parameters of the selected config as configurable child objects similar to how options are passed to a plugin?
@BinToss BinToss changed the title docs: examples of 'config' option usage docs: improve documentation of 'config' option Sep 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@BinToss