Skip to content

Missing documentation for the configuration file #891

Open
@andreasciamanna

Description

@andreasciamanna

The Configuration section of the README.md file, says:

Configuration

You can configure standard-version either by:

  1. Placing a standard-version stanza in your package.json (assuming
    your project is JavaScript).
  2. Creating a .versionrc, .versionrc.json or .versionrc.js.
  • If you are using a .versionrc.js your default export must be a configuration object, or a function returning a configuration object.

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

conventional-changelog-config-spec has little to do with the configuration file of standard-version.

As far as I can see, there is no detailed documentation of the file, only some generic mentions that "Any of the command line parameters accepted by standard-version can instead be provided via configuration" (without saying how) and some specific configurations such as the bumpFiles.

If I want to skip tags, for instance, I need to figure out how by myself (which I did, looking at the source code or reading unrelated issues that were sharing their configuration file).

Maybe I'm just missing the place where this is documented?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions