Skip to content

GitHub Actions: fix components changelog CI check #70034

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
t-hamano merged 1 commit into from
May 1, 2025
Merged

GitHub Actions: fix components changelog CI check #70034

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions .github/workflows/check-components-changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
name: Check CHANGELOG diff
runs-on: ubuntu-latest
permissions:
contents: read
contents: read
Copy link
Member

@Mamaduka Mamaduka May 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My editor did the same correction yesterday, which I had to revert manually. Only happened once, so not sure what the problem is.

Copy link
Contributor Author

@t-hamano t-hamano May 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this is the result of wp-scripts format being run through lint-staged. Perhaps @wordpress/prettier-config is enforcing such rules?

steps:
- name: 'Get PR commit count'
env:
Expand All @@ -43,13 +43,13 @@ jobs:
- name: Check CHANGELOG status
env:
PR_NUMBER: ${{ github.event.number }}
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
BASE_SHA: ${{ github.event.pull_request.base.sha }}
run: |
changelog_path="packages/components/CHANGELOG.md"
optional_check_notice="This isn't a required check, so if you think your changes are small enough that they don't warrant a CHANGELOG entry, please go ahead and merge without one."

# Fail if the PR doesn't touch the changelog
if git diff --quiet "$HEAD_SHA" HEAD -- "$changelog_path"; then
if git diff --quiet "$BASE_SHA" HEAD -- "$changelog_path"; then
echo "Please add a CHANGELOG entry to $changelog_path"
echo
echo "${optional_check_notice}"
Expand Down
Loading