Mirrors/git-chglog
1
0
Fork 0
mirror of https://github.com/git-chglog/git-chglog.git synced 2026-01-23 02:15:12 +00:00
Code Issues Projects Releases Wiki Activity

docs: Add document related on --next-tag

Browse source
This commit is contained in:
tsuyoshiwada 2018-05-05 22:13:56 +09:00
parent f8f4ccb8b7
commit 83ccab2905
1 changed files with 22 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -154,7 +154,7 @@ USAGE:
There are the following specification methods for <tag query>.
1. <old>..<new> - Commit contained in <new> tags from <old>.
1. <old>..<new> - Commit contained in <old> tags from <new>.
2. <name>.. - Commit from the <name> to the latest tag.
3. ..<name> - Commit from the oldest tag to <name>.
4. <name> - Commit contained in <name>.
@ -163,6 +163,7 @@ OPTIONS:
--init generate the git-chglog configuration file in interactive
--config value, -c value specifies a different configuration file to pick up (default: ".chglog/config.yml")
--output value, -o value output path and filename for the changelogs. If not specified, output to stdout
--next-tag value treat unreleased commits as specified tags (EXPERIMENTAL)
--silent disable stdout output
--no-color disable color output [$NO_COLOR]
--no-emoji disable emoji output [$NO_EMOJI]
@ -194,7 +195,7 @@ EXAMPLE:
$ git-chglog --config custom/dir/config.yml
The above is a command that uses a configuration file placed other than ".chglog/config.yml".
The adove is a command that uses a configuration file placed other than ".chglog/config.yml".
```
@ -486,6 +487,25 @@ See godoc [RenderData][doc-render-data] for available variables.
By displaying it on the standard output, it makes it easy to change the contents.
</details>
<details>
<summary>Can I commit CHANGELOG changes before creating tags?</summary>
Yes, it can be solved by using the `--next-tag` flag.
For example, let's say you want to upgrade your project to `2.0.0`.
You can create CHANGELOG containing `2.0.0` as follows.
```bash
$ git-chglog --next-tag 2.0.0 -o CHANGELOG.md
$ git commit -am "release 2.0.0"
$ git tag 2.0.0
```
The point to notice is that before actually creating a tag with git, it is conveying the next version with `--next-tag` :+1:
This is a step that is necessary for project operation in many cases.
</details>