diff options
Diffstat (limited to 'doc/development/changelog.md')
| -rw-r--r-- | doc/development/changelog.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/development/changelog.md b/doc/development/changelog.md index b8e879c1826..35fadd61d41 100644 --- a/doc/development/changelog.md +++ b/doc/development/changelog.md @@ -118,7 +118,7 @@ Its simplest usage is to provide the value for `title`: bin/changelog 'Hey DZ, I added a feature to GitLab!' ``` -If you want to generate a changelog entry for GitLab EE, you will need to pass +If you want to generate a changelog entry for GitLab EE, you must pass the `--ee` option: ```plaintext @@ -144,10 +144,10 @@ At this point the script would ask you to select the category of the change (map ``` 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 +the command above on a branch called `feature/hey-dz`, it generates a `changelogs/unreleased/feature-hey-dz.yml` file. -The command will output the path of the generated file and its contents: +The command outputs the path of the generated file and its contents: ```plaintext create changelogs/unreleased/my-feature.yml @@ -175,7 +175,7 @@ type: You can pass the **`--amend`** argument to automatically stage the generated file and amend it to the previous commit. -If you use **`--amend`** and don't provide a title, it will automatically use +If you use **`--amend`** and don't provide a title, it uses the "subject" of the previous commit, which is the first line of the commit message: |