Skip to content

Commit e6f1175

Browse files
Update automatically-generated-release-notes.md
clarifies exclusion configuration example
1 parent 36c3a82 commit e6f1175

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,9 @@ Automatically generated release notes provide an automated alternative to manual
7171
| `changelog.categories[*].exclude.labels` | A list of labels that exclude a pull request from appearing in this category. |
7272
| `changelog.categories[*].exclude.authors` | A list of user or bot login handles whose pull requests are to be excluded from this category. |
7373

74-
### Example configuration
74+
### Example configurations
75+
76+
A configuration for a repository that labels semver releases
7577

7678
{% raw %}
7779
```yaml{:copy}
@@ -98,6 +100,26 @@ changelog:
98100
```
99101
{% endraw %}
100102

103+
A configuration for a repo that doesn't tag Pull Requests but wants to separate out Dependabot automated PRs in release notes (note: `labels: '*'` is required to display a catchall category)
104+
105+
{% raw %}
106+
```yaml{:copy}
107+
# .github/release.yml
108+
109+
changelog:
110+
categories:
111+
- title: 🏕 Features
112+
labels:
113+
- '*'
114+
exclude:
115+
labels:
116+
- dependencies
117+
- title: 👒 Dependencies
118+
labels:
119+
- dependencies
120+
```
121+
{% endraw %}
122+
101123
## Further reading
102124

103125
- "[Managing labels](/issues/using-labels-and-milestones-to-track-work/managing-labels)"

0 commit comments

Comments
 (0)