Debian Codegraph @

doc/changelog.d/readme.md

raw
1 # Usage
2
3 `towncrier` is used for keeping track of the changelog. The relevant configuration aspects are:
4 - Each file can be formatted using markdown
5 - The contents are rendered in bullets
6 - Each file should be labeled with the corresponding **pull request**, e.g. `NUM.TYPE.md`
7 + Where there is no clear corresponding pull request, `+` can be used instead of `NUM`
8
9 For mapping the types to headings, the following table can be used:
10
11
12 | **TYPE** | **Heading** |
13 | feat | New Features |
14 | api | API Changes |
15 | bugfix | Bug Fixes |
16 | misc | Other Changes and Additions |
17
18 ## Release
19
20
21 ```bash
22 # View the changes
23 towncrier build --draft --version 0.1.0 --date "$(date -u +%Y-%m-%d)"
24 # Modify CHANGES.md
25 towncrier build --version 0.1.0 --date "$(date -u +%Y-%m-%d)"
26 ```