diff --git a/.github/workflows/pr-checks.yaml b/.github/workflows/pr-checks.yaml new file mode 100644 index 0000000000..5569cdb7c5 --- /dev/null +++ b/.github/workflows/pr-checks.yaml @@ -0,0 +1,19 @@ +name: Run PR Checks + +on: + pull_request: + branches: + - develop # Branch to run checks on + +jobs: + # Verify that release notes have been updated. PRs should include summary of + # what has changed in the release notes. + check_release_notes: + runs-on: ubuntu-latest + name: Verify RELEASE_NOTES.md has been updated + steps: + - name: Verify RELEASE_NOTES.md updated + uses: takanuva15/verify-file-updated@v1 + with: + filename_to_check: RELEASE_NOTES.md # Check the RELEASE_NOTES.md for change + excused_label: "no release notes check" # Optional: add this label to PRs to skip the check diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index c72ac952b0..6d31a0ba2e 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -14,6 +14,7 @@ This release contains ... Notable changes include: * New features / API changes: + * Add check to verify release notes have been updated for a PR. * Build changes/improvements: