diff --git a/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md b/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md index 1b36e50c48..151756761d 100644 --- a/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md +++ b/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md @@ -75,7 +75,9 @@ You can also customize your automated release notes, using labels to create cust | `changelog.categories[*].exclude.labels` | A list of labels that exclude a pull request from appearing in this category. | | `changelog.categories[*].exclude.authors` | A list of user or bot login handles whose pull requests are to be excluded from this category. | -### Example configuration +### Example configurations + +A configuration for a repository that labels semver releases {% raw %} ```yaml{:copy} @@ -102,6 +104,26 @@ changelog: ``` {% endraw %} +A configuration for a repository that doesn't tag pull requests but where we want to separate out {% data variables.product.prodname_dependabot %} automated pull requests in release notes (`labels: '*'` is required to display a catchall category) + +{% raw %} +```yaml{:copy} +# .github/release.yml + +changelog: + categories: + - title: 🏕 Features + labels: + - '*' + exclude: + labels: + - dependencies + - title: 👒 Dependencies + labels: + - dependencies +``` +{% endraw %} + ## Further reading - "[Managing labels](/issues/using-labels-and-milestones-to-track-work/managing-labels)"