Skip to content

Commit 306c996

Browse files
Jerichogep13
authored andcommitted
(doc) Document the new include-contributors option
This new config option will be available in GRM 0.19.0 (when PR GitTools#541 is merged).
1 parent 819bf76 commit 306c996

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/input/docs/configuration/default-configuration.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ create:
2020
sha-section-heading: "SHA256 Hashes of the release artifacts"
2121
sha-section-line-format: "- `{1}\t{0}`"
2222
allow-update-to-published: false
23+
include-contributors: false
2324
export:
2425
include-created-date-in-title: false
2526
created-date-string-format: ''
@@ -135,7 +136,12 @@ control the look and feel of the generated release notes.
135136
- A boolean value which indicates whether or not updates can be applied to
136137
published releases. The default value is false. **NOTE:** This
137138
configuration option was added in version 0.11.0 of GitReleaseManager.
138-
139+
- **include-contributors**
140+
- A boolean value which indicates whether the list of contributors is included
141+
in the release notes. A contributor is defined as someone who opened an issue
142+
or submitted a PR. **NOTE:** This configuration option was added in version
143+
0.19.0 of GitReleaseManager .
144+
139145
See the [example create configuration section](create-configuration) to see an
140146
example of how a footer can be configured.
141147

0 commit comments

Comments
 (0)