Skip to content
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

Document the new include-contributors option #612

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

Document the new include-contributors option #612

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
8 changes: 7 additions & 1 deletion docs/input/docs/configuration/default-configuration.md
View file
Open in desktop
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
Loading