Skip to content

DOC: Document custom label->section mapping #1026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 9, 2023
Merged

DOC: Document custom label->section mapping #1026

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,7 @@ You can look for params names from the [parser source code (#setup_parser)](http
- Bug fixes (issues labeled `bug`) :beetle:
- Enhancements (issues labeled `enhancement`) :star2:
- Issues (closed issues with no labels) :non-potable_water:
- Plus any additional custom label-to-section mappings you want :gear:

- Manually include or exclude issues by labels :wrench:
- Customize lots more! Tweak the changelog to fit your preferences :tophat:
Expand Down Expand Up @@ -311,6 +312,17 @@ I'm not trying to compare the quality of handwritten and auto-generated logs. Th

An auto-generated changelog really helps, even if you manually fill in the release notes!

- **I want to define my own label-to-section mapping, how can I do it?**

This is possible using either the ``add-sections`` or ``configure-sections``
entry in ``.github_changelog_generator``. For example, to add a single new
entry called "Maintenance" that will catch PRs tagged with your ``maintenance``
label, you can add to ``.github_changelog_generator`` the line:
```
add-sections= {"maintenance":{"prefix":"**Project maintenance**","labels":["maintenance"]}}
```
A similar approach can be used via ``configure-sections`` to set all section
properties (including adding new ones!).

- ***My Ruby version is very old, can I use this?***

Expand Down