feat: add GitHub release config

Signed-off-by: Henry Schreiner <[email protected]>
scientific-python · May 10, 2024 · 731cbd9 · 731cbd9
1 parent dcd523c
commit 731cbd9
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/.github/release.yml b/.github/release.yml
@@ -0,0 +1,5 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot
+      - pre-commit-ci
diff --git a/docs/pages/guides/gha_basic.md b/docs/pages/guides/gha_basic.md
@@ -710,3 +710,21 @@ everything in one job, you only need one of these.
 >
 > - [CLIUtils.github.io/CLI11](https://github.com/CLIUtils/CLI11/blob/main/.github/workflows/docs.yml)
 > - [iris-hep.org](https://github.com/iris-hep/iris-hep.github.io/blob/master/.github/workflows/deploy.yml)
+
+### Changelog generation
+
+Not directly part of Actions, but also in `.github` is `.github/release.yml`,
+which lets you [configure the changelog generation][gh-changelog] button when
+you make a release. The following config will remove dependabot and
+pre-commit-ci PRs for you:
+
+```yaml
+changelog:
+  exclude:
+    authors:
+      - dependabot
+      - pre-commit-ci
+```
+
+[gh-changelog]:
+  https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
diff --git a/{{cookiecutter.project_name}}/.github/release.yml b/{{cookiecutter.project_name}}/.github/release.yml
@@ -0,0 +1,5 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot
+      - pre-commit-ci