|
⇤ ← Revision 1 as of 2017-07-31 13:45:00
Size: 1506
Comment:
|
Size: 1831
Comment: Add a general example.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 42: | Line 42: |
| A normal commit message will look like this- | {{{ commands: fix some things which are not right (issue1234) }}} If one has the above commit message for fixing issue 1234 and want to add something which can be added to release notes, one can add admonitions as used below. |
| Line 45: | Line 49: |
| .. fix:: Title fix 1 | commands: fix some things which are not right (issue1234) |
| Line 47: | Line 51: |
| Fixes issueNNNN. | .. fix:: Issue 1234 Fixes things which had wrong behaviour. |
| Line 50: | Line 56: |
| Now run the command {{{hg releasenotes -r . <FILENAME>}}}. This generates the following notes: | Now when someone/you will run the command {{{hg releasenotes <FILENAME>}}}, the following will be added to the release notes file: |
| Line 56: | Line 62: |
| Title fix 1 | Issue 1234 |
| Line 59: | Line 65: |
| Fixes issueNNNN. | Fixes things which had wrong behaviour. |
| Line 61: | Line 67: |
Releasenotes extension
Contents
1. Overview
This extension allows automatic generation of release notes by tagging commit messages to a release notes area.
2. Configuration
Configure your .hgrc to enable the extension by adding following lines:
[extensions] releasenotes=
The extension consists of default sections:
fix = Bug fixes feature = New Features perf = Performance Improvements bc = Backwards Compatibility Changes api = API Changes
For adding custom sections, add a file .hgreleasenotes to the project's root directory. To specify the custom admonitions, use the following format.
[sections] section1 = Title of Section 1 section2 = Title of Section 2
In order to change the title of any of the default sections, just specify the existing admonition with a new title in the .hgreleasenotes file and it will override the default title.
3. Usage
The extension parses reStructuredText sections from commit messages to generate release notes. The user will hence need to add admonitions to commit messages.
commands: fix some things which are not right (issue1234)
If one has the above commit message for fixing issue 1234 and want to add something which can be added to release notes, one can add admonitions as used below.
commands: fix some things which are not right (issue1234) .. fix:: Issue 1234 Fixes things which had wrong behaviour.
Now when someone/you will run the command hg releasenotes <FILENAME>, the following will be added to the release notes file:
Bug Fixes ========= Issue 1234 ----------- Fixes things which had wrong behaviour.
For any further help, you can use hg releasenotes -h