Skip to content

Commit

Permalink
Add note about not writing a changelog and setting options from CLI (c…
Browse files Browse the repository at this point in the history
…loses #48)
  • Loading branch information
webpro committed Feb 15, 2023
1 parent 8f43427 commit 6166bd8
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Expand Up @@ -75,6 +75,7 @@ Default value: `undefined`
history.
- When `infile` is not set, the changelog generated by this plugin will still be used as release notes for e.g.
[GitHub Releases](https://github.com/release-it/release-it/blob/master/docs/github-releases.md).
- Set `infile: false` to disable the changelog writing (and only use the recommended bump for the next version).

### `header`

Expand Down Expand Up @@ -209,6 +210,21 @@ module.exports = {
};
```

## Command-line

Options for this plugin can be set from the command line. Some examples:

```
release-it --plugins.@release-it/conventional-changelog.infile=history.md
release-it --no-plugins.@release-it/conventional-changelog.infile
```

- Keys are separated by dots.
- Values can be negated by prefixing the key with `no-`.
- Arguments may need to be single-quoted (`'`) such as `--'deep.key=value'` or `'--deep.key=value'`

Depending on your shell or OS this may differ.

## GitHub Actions

When using this plugin in a GitHub Action, make sure to set
Expand Down

0 comments on commit 6166bd8

Please sign in to comment.