From 6166bd8e279948bd02b64db7bba987335f1e0588 Mon Sep 17 00:00:00 2001 From: Lars Kappert Date: Wed, 15 Feb 2023 18:23:17 +0100 Subject: [PATCH] Add note about not writing a changelog and setting options from CLI (closes #48) --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 45030f9..f004ab3 100644 --- a/README.md +++ b/README.md @@ -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` @@ -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