From e6f1175d61b3544327c4b828d030eea9a8198b5e Mon Sep 17 00:00:00 2001 From: Kate Donaldson Date: Mon, 23 May 2022 18:42:35 -0500 Subject: [PATCH 1/3] Update automatically-generated-release-notes.md clarifies exclusion configuration example --- .../automatically-generated-release-notes.md | 24 ++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) 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 4e1e76f38b..f3524536bf 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 @@ -71,7 +71,9 @@ Automatically generated release notes provide an automated alternative to manual | `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} @@ -98,6 +100,26 @@ changelog: ``` {% endraw %} +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) + +{% 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)" From b2c26c4387525d3fac4f9a4a231d41cc9083f4d2 Mon Sep 17 00:00:00 2001 From: mc <42146119+mchammer01@users.noreply.github.com> Date: Tue, 29 Nov 2022 17:37:31 +0000 Subject: [PATCH 2/3] Apply suggestions from code review --- .../automatically-generated-release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 895cfbc2ef..fae507d07c 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 @@ -104,7 +104,7 @@ changelog: ``` {% endraw %} -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) +A configuration for a repository that doesn't tag pull requests but where we want to separate out Dependabot automated pull requests in release notes (`labels: '*'` is required to display a catchall category) {% raw %} ```yaml{:copy} From f74732dee9e646cb8c8fed27be3fbc30482d0109 Mon Sep 17 00:00:00 2001 From: mc <42146119+mchammer01@users.noreply.github.com> Date: Tue, 29 Nov 2022 17:38:32 +0000 Subject: [PATCH 3/3] Update content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md --- .../automatically-generated-release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 fae507d07c..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 @@ -104,7 +104,7 @@ changelog: ``` {% endraw %} -A configuration for a repository that doesn't tag pull requests but where we want to separate out Dependabot automated pull requests in release notes (`labels: '*'` is required to display a catchall category) +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}