-
Notifications
You must be signed in to change notification settings - Fork 41
adding PR test for changelog entry #453
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.
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
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
4365acb
adding PR test for changelog entry
BSd3v 324770e
adding changelog updates detection
BSd3v 52df037
adjusting test to only be on PR and renaming file for schema
BSd3v 89c044f
Update .github/workflows/change-log.yml
BSd3v 58d0305
Update .github/workflows/change-log.yml
BSd3v 27de13e
Update .github/workflows/change-log.yml
BSd3v File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # yaml | ||
| name: Check changelog entry | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize, reopened] | ||
|
|
||
|
BSd3v marked this conversation as resolved.
|
||
| permissions: | ||
| contents: read | ||
| jobs: | ||
| check-changelog: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Determine changed files and require changelog update | ||
| env: | ||
| EVENT_NAME: ${{ github.event_name }} | ||
| PR_BASE_REF: ${{ github.event.pull_request.base.ref || '' }} | ||
| BEFORE: ${{ github.event.before }} | ||
| SHA: ${{ github.sha }} | ||
| run: | | ||
| set -euo pipefail | ||
|
|
||
| echo "Event: $EVENT_NAME" | ||
|
|
||
| if [ "$EVENT_NAME" = "pull_request" ]; then | ||
| if [ -z "$PR_BASE_REF" ]; then | ||
| echo "Pull request base ref not provided." | ||
| exit 1 | ||
| fi | ||
| echo "Fetching base ref origin/$PR_BASE_REF" | ||
| if ! git fetch origin "$PR_BASE_REF":refs/remotes/origin/"$PR_BASE_REF"; then | ||
| echo "::error::Failed to fetch pull request base ref origin/$PR_BASE_REF." | ||
| exit 1 | ||
| fi | ||
| changed=$(git diff --name-only "origin/$PR_BASE_REF...HEAD") | ||
| else | ||
| if [ "$BEFORE" = "0000000000000000000000000000000000000000" ]; then | ||
| # new branch or forced push: list files in the commit | ||
| changed=$(git show --name-only --pretty="" "$SHA") | ||
| else | ||
| changed=$(git diff --name-only "$BEFORE...$SHA") | ||
| fi | ||
| fi | ||
|
|
||
| echo "Changed files:" | ||
| echo "$changed" | sed 's/^/ - /' | ||
|
|
||
| # match: CHANGELOG.md, NEWS.md, any file under changelog(s)/ or docs/changelog/ | ||
| echo "$changed" | grep -E '(^CHANGELOG\.md$|^NEWS\.md$|(^|/)changelog(/|$)|(^|/)changelogs(/|$)|(^|/)docs/changelog(/|$))' >/dev/null 2>&1 || { | ||
| echo "::error::No changelog changes detected." | ||
| echo "Please add or update a changelog entry (e.g. update `CHANGELOG.md` or add a file under `changelog/`)." | ||
| exit 1 | ||
| } | ||
|
|
||
| echo "Changelog change detected. OK." | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.