Skip to content

Commit 651be5e

Browse files
committed
issue #1 - Update README with contributors section configuration example
Added an example YAML configuration demonstrating how to enable and customize a contributors section in release notes.
1 parent b387ed1 commit 651be5e

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.adoc

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ ghrnc:
3737

3838
The `ghrnc.github-token` is optional but increases the rate limit of GitHub. If required, the endpoint of the GitHub API could be set with `ghrnc.base-url`.
3939

40-
If `sections` isn't set, the following default is used:
40+
If `ghrnc.sections` isn't set, the following default is used:
4141

4242
[source,yaml]
4343
----
@@ -51,6 +51,20 @@ ghrnc:
5151
labels: ["documentation"]
5252
----
5353

54+
Optionally, a list of all contributors can be created. The corresponding configuration may look like this:
55+
56+
[source,yaml]
57+
----
58+
ghrnc:
59+
contributors:
60+
enabled: true
61+
title: ":heart: Contributors"
62+
message: "Thank you to all the contributors who worked on this release."
63+
excludes:
64+
- "core-developer-1"
65+
- "core-developer-2"
66+
----
67+
5468
== Running Standalone
5569

5670
Download the https://github.com/th-schwarz/GithubReleaseNotesCreator/releases[last release jar].

0 commit comments

Comments
 (0)