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.

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

Make it more obvious that some/all config options can be set via separate config #148

Open
ST-DDT opened this issue May 6, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ST-DDT
Copy link

ST-DDT commented May 6, 2024

Describe the bug

I tried to lookup how to set the skip config option and the skip option only mentions it being added to the package.json and it doesn't show up in the conventional-commit-config-spec.

I especially find these two sections confusing:

Any of the command line parameters accepted by commit-and-tag-version can instead be provided via configuration. Please refer to the conventional-changelog-config-spec for details on available configuration options.

[...] by adding the following to your package.json:

Current behavior

The spec/readme give the impression that some config options need to be set via package.json

Expected behavior

  • The config spec should list all supported properties or mention that the list is only a subset of config options.
  • The readme should either mention the package.json less or also mention the config file.
    e.g. by adding the following to your package.json or config file:

Environment

  • commit-and-tag-version version(s): v12.4.1
  • GitHub Readme on master

Possible Solution

  • See expected behavior

Additional context

@ST-DDT ST-DDT added the bug Something isn't working label May 6, 2024
@TimothyJones TimothyJones added documentation Improvements or additions to documentation and removed bug Something isn't working labels May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants