Skip to content

Commit a1b11e9

Browse files
committed
(doc) Added documentation for label aliases
1 parent 1eae315 commit a1b11e9

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

docs/configuration/label-aliases.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Label Aliases
2+
3+
When there are more than one issue associated with a particular label, GitReleaseManager will attempt to pluralize the label name. For example, `Bugs` instead of `Bug`. However, there are times when this basic pluralization will not work. For example, `Documentation` will be pluralized as `Documentations` which doesn't really make sense. In these situations, it is possible to override the automatic title.
4+
5+
This is possible for both the singular and plural cases.
6+
7+
Here is an example of how to configure two label aliases. The title `Foo` will be used instead of `Bug`, and `Baz` instead of `Improvement`. If each label contains more than one feature, `Bar` and `Qux` will be used instead in the release notes.
8+
9+
```
10+
issue-labels-alias:
11+
- name: Bug
12+
header: Foo
13+
plural: Bar
14+
15+
- name: Improvement
16+
header: Baz
17+
plural: Qux
18+
```
19+
20+
<div class="admonition note">
21+
<p class="first admonition-title">Note</p>
22+
<p class="last">
23+
You can add as many label aliases as required.
24+
</p>
25+
</div>

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ pages:
1515
- Example of Export Configuration: configuration/export-configuration.md
1616
- Issues to include: configuration/include-issues.md
1717
- Issues to exclude: configuration/exclude-issues.md
18+
- Label Aliases: label-aliases.md
1819
- Commands:
1920
- Create: commands/create.md
2021
- Add Assets: commands/add-assets.md

0 commit comments

Comments
 (0)