Workflows: test to check for label and skip backport changelog #61808

ramonjd · 2024-05-20T22:20:24Z

What?

Follow up to:

Workflows: try a backport changelog #61785

Skips the backport changelog check in CI if the "No Core sync required" label is applied to a PR.

Why?

Folks might want to add changes that do not require a Core backport, e.g., syncing from Core to Gutenberg.

How?

Add an if condition to the action.

Testing Instructions

Make a PHP change in a new branch.

The check should fail.

Now add the "No Core sync required" or "Backport from WordPress Core" label

The CI should refresh and the check will not fail.

github-actions · 2024-05-20T22:20:38Z

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: ramonjd <ramonopoly@git.wordpress.org>
Co-authored-by: tellthemachines <isabel_brison@git.wordpress.org>
Co-authored-by: ellatrix <ellatrix@git.wordpress.org>
Co-authored-by: priethor <priethor@git.wordpress.org>

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

github-actions · 2024-05-20T22:24:02Z

This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress.

If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core Github repository soon after this pull request is merged.

If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack.

Thank you! ❤️

View changed files

❔ lib/class-wp-rest-global-styles-controller-gutenberg.php

Test PHP change Action

ramonjd · 2024-05-20T22:45:05Z

.github/workflows/check-backport-changelog.yml

@@ -31,6 +31,7 @@ jobs:
            - name: 'Fetch relevant history from origin'
              run: git fetch origin ${{ github.event.pull_request.base.ref }}
            - name: Check CHANGELOG status
+              if: ${{ !contains(github.event.pull_request.labels.*.name, 'No Core sync required') }}


The target label could easily be "Backport from WordPress Core", but there might be other scenarios where a backport isn't required, e.g., adding gutenberg text domains to i18n translations.

Could we have multiple target labels? It would be really handy to look at "Backport from WordPress Core" too!

Good call. I'll test.

Done in 2ac0b2b

ramonjd · 2024-05-20T22:45:15Z

lib/class-wp-rest-global-styles-controller-gutenberg.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * REST API: Try: bundle WP_Theme_JSON class instead of inheriting per WordPress version class
+ * REST API: Bundle WP_Theme_JSON class instead of inheriting per WordPress version class


Might as well leave this in. 😄

github-actions · 2024-05-20T23:05:46Z

Flaky tests detected in f4f5f3c.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9178873250
📝 Reported issues:

[Flaky Test] Clicking on inserter while on zoom-out should open the patterns tab on the inserter #61806 in /test/e2e/specs/site-editor/zoom-out.spec.js

ellatrix · 2024-05-21T04:26:56Z

An explicit label sounds good, yes 👍

ellatrix · 2024-05-21T04:54:08Z

.github/workflows/check-backport-changelog.yml

@@ -31,6 +31,7 @@ jobs:
            - name: 'Fetch relevant history from origin'
              run: git fetch origin ${{ github.event.pull_request.base.ref }}
            - name: Check CHANGELOG status
+              if: ${{ !contains(github.event.pull_request.labels.*.name, 'No Core sync required') && !contains(github.event.pull_request.labels.*.name, 'Backport from WordPress Core') }}


Are there other cases where no core sync is required, or is it just backports from core?

And a nit: could we title case the label? All other labels are, and most likely someone will, which will break the test

Alternatively we could remove the label if you think there's no other types of changes except for backports from core. I think in other cases we should probably add it to the excluded paths.

Are there other cases where no core sync is required, or is it just backports from core?

There are possibly several situations aside from backports:

Experimental code wrapped in defined( 'IS_GUTENBERG_PLUGIN' )

Experimental code in general :)

Adding gutenberg text domains to i18n translations (needed in the plugin, but not in Core)

Gutenberg hotfixes?

I'm out of ideas.... 😄

And a nit: could we title case the label? All other labels are, and most likely someone will, which will break the test

Good call. Will do, thanks!

ellatrix · 2024-05-21T04:56:28Z

Had to see test it for myself 😄

ellatrix · 2024-05-21T05:00:56Z

Thanks for improving the script! ❤️

priethor · 2024-05-21T14:12:59Z

An explicit label sounds good, yes 👍

Agreed, as it enables opting-out but the default is still to require backports. 💯

…ress#61808) * Test to check for label and skip check Test PHP change Action * Added extra label check * Sentence case for the label: No Core Sync Required Co-authored-by: ramonjd <ramonopoly@git.wordpress.org> Co-authored-by: tellthemachines <isabel_brison@git.wordpress.org> Co-authored-by: ellatrix <ellatrix@git.wordpress.org> Co-authored-by: priethor <priethor@git.wordpress.org>

ramonjd requested a review from desrosj as a code owner May 20, 2024 22:20

ramonjd added the [Type] Build Tooling Issues or PRs related to build tooling label May 20, 2024

ramonjd requested a review from spacedmonkey as a code owner May 20, 2024 22:22

ramonjd added No Core Sync Required Indicates that any changes do not need to be synced to WordPress Core and removed No Core Sync Required Indicates that any changes do not need to be synced to WordPress Core labels May 20, 2024

ramonjd force-pushed the try/skip-backwards-compat-changelog-with-label branch from 868f3b7 to daf6c24 Compare May 20, 2024 22:35

ramonjd added No Core Sync Required Indicates that any changes do not need to be synced to WordPress Core and removed No Core Sync Required Indicates that any changes do not need to be synced to WordPress Core labels May 20, 2024

Test to check for label and skip check

519383d

Test PHP change Action

ramonjd force-pushed the try/skip-backwards-compat-changelog-with-label branch from b087b4d to 519383d Compare May 20, 2024 22:41

ramonjd commented May 20, 2024

View reviewed changes

ramonjd requested a review from ellatrix May 20, 2024 22:45

ramonjd mentioned this pull request May 20, 2024

Workflows: try a backport changelog #61785

Merged

ramonjd changed the title ~~Workflows: test to check for label and skip check~~ Workflows: test to check for label and skip backport changelog test May 20, 2024

ramonjd changed the title ~~Workflows: test to check for label and skip backport changelog test~~ Workflows: test to check for label and skip backport changelog May 20, 2024

ramonjd requested review from noisysocks, tellthemachines and andrewserong May 20, 2024 23:13

Added extra label check

2ac0b2b

ellatrix reviewed May 21, 2024

View reviewed changes

ellatrix removed the No Core Sync Required Indicates that any changes do not need to be synced to WordPress Core label May 21, 2024

ellatrix added the No Core Sync Required Indicates that any changes do not need to be synced to WordPress Core label May 21, 2024

ellatrix approved these changes May 21, 2024

View reviewed changes

Sentence case for the label: No Core Sync Required

f4f5f3c

ramonjd merged commit f306978 into trunk May 21, 2024
62 checks passed

ramonjd deleted the try/skip-backwards-compat-changelog-with-label branch May 21, 2024 23:49

github-actions bot added this to the Gutenberg 18.5 milestone May 21, 2024

ellatrix mentioned this pull request May 24, 2024

PHP backports for WP 6.6 #61226

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Workflows: test to check for label and skip backport changelog #61808

Workflows: test to check for label and skip backport changelog #61808

ramonjd commented May 20, 2024 •

edited

Loading

github-actions bot commented May 20, 2024 •

edited

Loading

github-actions bot commented May 20, 2024

ramonjd May 20, 2024 •

edited

Loading

tellthemachines May 20, 2024

ramonjd May 20, 2024

ramonjd May 21, 2024 •

edited

Loading

ramonjd May 20, 2024

github-actions bot commented May 20, 2024 •

edited

Loading

ellatrix commented May 21, 2024

ellatrix May 21, 2024

ellatrix May 21, 2024

ellatrix May 21, 2024

ramonjd May 21, 2024

ramonjd May 21, 2024

ellatrix commented May 21, 2024

ellatrix commented May 21, 2024

priethor commented May 21, 2024

Workflows: test to check for label and skip backport changelog #61808

Workflows: test to check for label and skip backport changelog #61808

Conversation

ramonjd commented May 20, 2024 • edited Loading

What?

Why?

How?

Testing Instructions

github-actions bot commented May 20, 2024 • edited Loading

github-actions bot commented May 20, 2024

ramonjd May 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ramonjd May 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 20, 2024 • edited Loading

ellatrix commented May 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ellatrix commented May 21, 2024

ellatrix commented May 21, 2024

priethor commented May 21, 2024

ramonjd commented May 20, 2024 •

edited

Loading

github-actions bot commented May 20, 2024 •

edited

Loading

ramonjd May 20, 2024 •

edited

Loading

ramonjd May 21, 2024 •

edited

Loading

github-actions bot commented May 20, 2024 •

edited

Loading