From fbe9fdba9ee21ee915dcd18a04a3ff9240c90b1b Mon Sep 17 00:00:00 2001 From: Marco Cesarato Date: Thu, 21 Jan 2021 12:12:39 +0100 Subject: [PATCH] docs(readme): add config option and adjust usage list example --- README.md | 29 +++++++++-------------------- 1 file changed, 9 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 5edba25..9a0e11a 100644 --- a/README.md +++ b/README.md @@ -102,9 +102,7 @@ The changelog generator will generate a log of changes from the date of the last and it will put all commit logs in the latest version just created (at the moment it doesn't generate the entire git commit version release history). By default, will be added one to the patch semver part *(Example, if the last version is `1.0.2` the newer, if not specified the identity of the release, will be `1.0.3`)*. ---- - -To generate your changelog for your first release: +##### To generate your changelog for your first release: > **Note:** If the version code (`--ver`) isn't specified it will be automatically `1.0.0` @@ -112,41 +110,32 @@ To generate your changelog for your first release: php vendor/bin/conventional-changelog --first-release ``` ---- -To generate your changelog without committing files: +##### To generate your changelog without committing files: -```shell +```shell php vendor/bin/conventional-changelog ``` ---- - -To generate your changelog with auto commit and auto version tagging: +##### To generate your changelog with auto commit and auto version tagging: ```shell php vendor/bin/conventional-changelog --commit ``` ---- - -To generate your changelog from a specified date to another specified date: +##### To generate your changelog from a specified date to another specified date: ```shell php vendor/bin/conventional-changelog --from-date="2020-12-01" --to-date="2021-01-01" ``` ---- - -To generate your changelog with a specific version code: +##### To generate your changelog with a specific version code: ```shell php vendor/bin/conventional-changelog --ver="2.0.1" ``` ---- - -To generate your changelog with the entire history of changes of all releases: +##### To generate your changelog with the entire history of changes of all releases: > **Warn:** This operation will overwrite the `CHANGELOG.md` file if it already exists @@ -154,13 +143,13 @@ To generate your changelog with the entire history of changes of all releases: php vendor/bin/conventional-changelog --history ``` ---- ### Commands List > You can have more info about running `php vendor/bin/conventional-changelog --help` ``` + --config str Specify the configuration file path -c --commit bool Commit the new release once changelog is generated -a --amend bool Amend commit the new release once changelog is generated --major bool Major release (important changes) @@ -172,7 +161,7 @@ php vendor/bin/conventional-changelog --history --first-release bool Run at first release (if --ver isn't specified version code will be 1.0.0) --to-date str Get commits from last tag date (or specified on --from-date) to specified date [YYYY-MM-DD] --from-date str Get commits from specified date [YYYY-MM-DD] - --ver str Define the next release version code (semver) + --ver str Specify the next release version code (semver) --history bool Generate the entire history of changes of all releases --no-verify bool Bypasses the pre-commit and commit-msg hooks --no-tag bool Disable release auto tagging when commit enabled