Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Jérome Perrin
gitlab-ce
Commits
c59dfad9
Commit
c59dfad9
authored
Jan 03, 2017
by
Robert Speicher
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Minor improvements to changelog docs
[ci skip]
parent
10960d6e
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
10 additions
and
5 deletions
+10
-5
doc/development/changelog.md
doc/development/changelog.md
+10
-5
No files found.
doc/development/changelog.md
View file @
c59dfad9
...
@@ -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!
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment