summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRobert Speicher <rspeicher@gmail.com>2016-11-02 22:15:20 +0000
committerRobert Speicher <rspeicher@gmail.com>2016-11-02 22:15:20 +0000
commit895673733a5712ee4b69c84195a1d717a72fc032 (patch)
treee8cdf2b42901430a88b1ad77525c77caa36513b8 /doc
parent99a12e120953c7b11d35a65e002a7906f30a99cb (diff)
downloadgitlab-ce-895673733a5712ee4b69c84195a1d717a72fc032.tar.gz
Add a `--force` option to bin/changelogrs-changelog-force
Diffstat (limited to 'doc')
-rw-r--r--doc/development/changelog.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/development/changelog.md b/doc/development/changelog.md
index d08c476e9d6..390eb549d0b 100644
--- a/doc/development/changelog.md
+++ b/doc/development/changelog.md
@@ -46,13 +46,14 @@ 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` file.
+`changelogs/unreleased/feature-hey-dz.yml` file.
### Arguments
| Argument | Shorthand | Purpose |
| ----------------- | --------- | --------------------------------------------- |
| `--amend` | | Amend the previous commit |
+| `--force` | `-f` | Overwrite an existing entry |
| `--merge-request` | `-m` | Merge Request ID |
| `--dry-run` | `-n` | Don't actually write anything, just print |
| `--git-username` | `-u` | Use Git user.name configuration as the author |
@@ -79,6 +80,23 @@ merge_request:
author:
```
+#### `--force` or `-f`
+
+Use **`--force`** or **`-f`** to overwrite an existing changelog entry if it
+already exists.
+
+```text
+$ bin/changelog 'Hey DZ, I added a feature to GitLab!'
+error changelogs/unreleased/feature-hey-dz.yml already exists! Use `--force` to overwrite.
+
+$ bin/changelog 'Hey DZ, I added a feature to GitLab!' --force
+create changelogs/unreleased/feature-hey-dz.yml
+---
+title: Hey DZ, I added a feature to GitLab!
+merge_request: 1983
+author:
+```
+
#### `--merge-request` or `-m`
Use the **`--merge-request`** or **`-m`** argument to provide the