Skip to content

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

Open
@ST-DDT

Description

@ST-DDT

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions