README.md
Changelog folder
This repo uses chloggen to manage its changelog files. You can find the source code for the tool here.
Here is a quick explanation of the config.yaml file for chloggen:
yaml
| 1 | # The directory that stores individual changelog entries. |
| 2 | # Each entry is stored in a dedicated yaml file. |
| 3 | # - 'chloggen new' will copy the 'template_yaml' to this directory as a new entry file. |
| 4 | # - 'chloggen validate' will validate that all entry files are valid. |
| 5 | # - 'chloggen update' will read and delete all entry files in this directory, and update 'changelog_md'. |
| 6 | # Specify as relative path from root of repo. |
| 7 | # (Optional) Default: .chloggen |
| 8 | entries_dir: .chloggen |
| 9 | |
| 10 | # This file is used as the input for individual changelog entries. |
| 11 | # Specify as relative path from root of repo. |
| 12 | # (Optional) Default: .chloggen/TEMPLATE.yaml |
| 13 | template_yaml: .chloggen/TEMPLATE.yaml |
| 14 | |
| 15 | summary_template: .chloggen/summary.tmpl |
| 16 | |
| 17 | # The CHANGELOG file or files to which 'chloggen update' will write new entries |
| 18 | # (Optional) Default filename: CHANGELOG.md |
| 19 | change_logs: |
| 20 | user: CHANGELOG.md |
| 21 | api: CHANGELOG-API.md |
| 22 | |
| 23 | # The default change_log or change_logs to which an entry should be added. |
| 24 | # If 'change_logs' is specified in this file, and no value is specified for 'default_change_logs', |
| 25 | # then 'change_logs' MUST be specified in every entry file. |
| 26 | default_change_logs: [user] |