Skip to content

Commit

Permalink
Document the new include-contributors option
Browse files Browse the repository at this point in the history
This new config option will be available in GRM 0.19.0 (when PR GitTools#541  is merged).
  • Loading branch information
Jericho authored Jul 20, 2024
1 parent 8987ebd commit b40c5df
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/input/docs/configuration/default-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ create:
sha-section-heading: "SHA256 Hashes of the release artifacts"
sha-section-line-format: "- `{1}\t{0}`"
allow-update-to-published: false
include-contributors: false
export:
include-created-date-in-title: false
created-date-string-format: ''
Expand Down Expand Up @@ -135,7 +136,12 @@ control the look and feel of the generated release notes.
- A boolean value which indicates whether or not updates can be applied to
published releases. The default value is false. **NOTE:** This
configuration option was added in version 0.11.0 of GitReleaseManager.

- **include-contributors**
- A boolean value which indicates whether the list of contributors is included
in the release notes. A contributor is defined as soneone who opened an issue
or submitted a PR. **NOTE:** This configuration option was added in version
0.19.0 of GitReleaseManager .

See the [example create configuration section](create-configuration) to see an
example of how a footer can be configured.

Expand Down

0 comments on commit b40c5df

Please sign in to comment.