Skip to content

Commit 3e53f01

Browse files
authored
Add CI check that RELEASE_NOTES.md was updated (#544)
This PR adds a CI check to ensure that all PRs have a release note. Except when a commit message contains `[skip relnotes]` This is just a suggestion, if you don't like this solution or have a better idea, please let me know.
2 parents 2f11f0d + bcd993d commit 3e53f01

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Release Notes Check
2+
3+
on:
4+
pull_request:
5+
types:
6+
# On by default if you specify no types.
7+
- "opened"
8+
- "reopened"
9+
- "synchronize"
10+
# For `skip-label` only.
11+
- "labeled"
12+
- "unlabeled"
13+
14+
jobs:
15+
check-release-notes:
16+
name: Check release notes are updated
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Check for a release notes update
20+
uses: brettcannon/check-for-changed-files@294a99714e0d350b5083472a293d41bc91804e68 # v1.1.1
21+
with:
22+
file-pattern: "RELEASE_NOTES.md"
23+
prereq-pattern: "src/**"
24+
skip-label: "cmd:skip-release-notes"
25+
failure-message: "Missing a release notes update. Please add one or apply the ${skip-label} label to the pull request"

0 commit comments

Comments
 (0)