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.

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 1 commit into from
May 1, 2025

Conversation

t-hamano
Copy link
Contributor

@t-hamano t-hamano commented May 1, 2025

What?

There is CI that checks whether PRs that make changes to @wordpress/components package have updated CHANGELOG file.

We noticed that this CI isn't working even though we have added a correct changelog entry (Example: #69969 (comment)).

This PR fixes the problem.

Why?

As far as I know, this problem occurred as a result of #69126. We should check the diff against the base branch, but I think github.event.pull_request.base.sha was unexpectedly replaced with github.event.pull_request.head.sha.

https://github.com/WordPress/gutenberg/pull/69126/files#diff-7077ded14418b5bee6455b705ec9de4d9420d58c999f5b5e2fb66848f391a87cR46-R52

Testing Instructions

We currently have no way to test this, but it should work.

@t-hamano t-hamano added the GitHub Actions Pull requests that update GitHub Actions code label May 1, 2025
@t-hamano t-hamano requested a review from desrosj as a code owner May 1, 2025 06:59
@t-hamano t-hamano marked this pull request as draft May 1, 2025 06:59
@t-hamano t-hamano added the [Type] Bug An existing feature does not function as intended label May 1, 2025
@t-hamano t-hamano requested review from johnbillion and Mamaduka May 1, 2025 07:08
@t-hamano t-hamano marked this pull request as ready for review May 1, 2025 07:08
Copy link

github-actions bot commented May 1, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: johnbillion <johnbillion@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Member

@Mamaduka Mamaduka left a comment

Choose a reason for hiding this comment

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

Thanks for investigating this, @t-hamano!

The changes here make sense and seem to match previous logic, but I would defer to @johnbillion and @desrosj for final approval.

@@ -24,7 +24,7 @@ jobs:
name: Check CHANGELOG diff
runs-on: ubuntu-latest
permissions:
contents: read
contents: read
Copy link
Member

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

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?

Copy link
Member

@johnbillion johnbillion left a comment

Choose a reason for hiding this comment

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

Good spot, thanks @t-hamano.

@t-hamano t-hamano merged commit 06bae56 into trunk May 1, 2025
72 of 74 checks passed
@t-hamano t-hamano deleted the github-actions-components-changelog branch May 1, 2025 08:25
@github-actions github-actions bot added this to the Gutenberg 20.8 milestone May 1, 2025
chriszarate pushed a commit to chriszarate/gutenberg that referenced this pull request Jul 1, 2025
Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: johnbillion <johnbillion@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GitHub Actions Pull requests that update GitHub Actions code [Type] Bug An existing feature does not function as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants