Skip to content

Commit

Permalink
docs(readme): clarify bump version processs
Browse files Browse the repository at this point in the history
  • Loading branch information
marcocesarato committed Jan 17, 2021
1 parent 91df9cc commit ba92277
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ Now you can just run `composer changelog` to generate your changelog.
The changelog generator will generate a log of changes from the date of the last tag (if not specified with `--from-date`) to the current date (if not specified with` --to-date`),
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)

> **PS:** all following commands must be run (working dir) on the root of the project or in the path where the changelog should be generated
The changelog generator will generate a log of changes from the date of the last tag *(if not specified with `--from-date`)* to the current date *(if not specified with `--to-date`)*,
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`)*.

- Generate a changelog without committing files:

`php vendor/bin/conventional-changelog`
Expand All @@ -58,13 +64,15 @@ and it will put all commit logs in the latest version just created (at the momen

### Commands List

> You can have more info about running `php vendor/bin/conventional-changelog --help`
```
-c --commit bool Commit the new release once changelog is generated
-f --from-date str Get commits from specified date [YYYY-MM-DD]
-h --help bool Show the helper with all commands available
-m --major bool Major release (important changes)
-n --minor bool Minor release (add functionality)
-p --patch bool Patch release (bug fixes)
-p --patch bool Patch release (bug fixes) [default]
-t --to-date str Get commits from last tag date (or specified on --from-date) to specified date [YYYY-MM-DD]
-v --version str Specify next release version code (Semver)
```

0 comments on commit ba92277

Please sign in to comment.