Commit c59dfad9 authored by Robert Speicher's avatar Robert Speicher

Minor improvements to changelog docs

[ci skip]
parent 10960d6e
...@@ -40,6 +40,15 @@ Its simplest usage is to provide the value for `title`: ...@@ -40,6 +40,15 @@ Its simplest usage is to provide the value for `title`:
```text ```text
$ bin/changelog 'Hey DZ, I added a feature to GitLab!' $ bin/changelog 'Hey DZ, I added a feature to GitLab!'
```
The entry filename is based on the name of the current Git branch. If you run
the command above on a branch called `feature/hey-dz`, it will generate a
`changelogs/unreleased/feature-hey-dz.yml` file.
The command will output the path of the generated file and its contents:
```text
create changelogs/unreleased/my-feature.yml create changelogs/unreleased/my-feature.yml
--- ---
title: Hey DZ, I added a feature to GitLab! title: Hey DZ, I added a feature to GitLab!
...@@ -47,10 +56,6 @@ merge_request: ...@@ -47,10 +56,6 @@ merge_request:
author: author:
``` ```
The entry filename is based on the name of the current Git branch. If you run
the command above on a branch called `feature/hey-dz`, it will generate a
`changelogs/unreleased/feature-hey-dz.yml` file.
### Arguments ### Arguments
| Argument | Shorthand | Purpose | | Argument | Shorthand | Purpose |
...@@ -139,7 +144,7 @@ Use the **`--git-username`** or **`-u`** argument to automatically fill in the ...@@ -139,7 +144,7 @@ Use the **`--git-username`** or **`-u`** argument to automatically fill in the
$ git config user.name $ git config user.name
Jane Doe Jane Doe
$ bin/changelog --u 'Hey DZ, I added a feature to GitLab!' $ bin/changelog -u 'Hey DZ, I added a feature to GitLab!'
create changelogs/unreleased/feature-hey-dz.yml create changelogs/unreleased/feature-hey-dz.yml
--- ---
title: Hey DZ, I added a feature to GitLab! title: Hey DZ, I added a feature to GitLab!
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment