Skip to content

Add changelog CI check #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Radhika Gupta (rads-1996) merged 2 commits into from
Aug 5, 2026
Merged

Add changelog CI check #240

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e51923
Add changelog CI check
rads-1996 Aug 5, 2026
95367a2
Address feedback
rads-1996 Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/workflows/pr-validation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,32 @@ permissions:
contents: read

jobs:
changelog:
name: CHANGELOG updated
runs-on: ubuntu-latest
if: >-
github.event_name == 'pull_request' &&
!contains(github.event.pull_request.labels.*.name, 'skip-changelog')

steps:
- name: Check out repository
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Verify CHANGELOG.md was updated
env:
BASE_SHA: ${{ github.event.pull_request.base.sha }}
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
run: |
if git diff --name-only "$BASE_SHA...$HEAD_SHA" | grep -qx 'CHANGELOG.md'; then
echo "CHANGELOG.md was updated."
else
echo "::error::CHANGELOG.md was not updated in this PR."
echo "Add an entry to CHANGELOG.md, or apply the 'skip-changelog' label if this change does not warrant one."
exit 1
fi

quality:
name: Black, Pylint, and Mypy
runs-on: ubuntu-latest
Expand Down
Loading