Skip to content
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

Assets: Add README.md about syncing #68128

Merged
merged 10 commits into from
Dec 19, 2024
Merged

Assets: Add README.md about syncing #68128

merged 10 commits into from
Dec 19, 2024

Conversation

ockham
Copy link
Contributor

@ockham ockham commented Dec 19, 2024

What?

Add a README.md to the assets/ directory, to document how it is synced to the plugin repository.

Follow-up to #68052. See #68052 (comment).

Why?

It's not that obvious.

How?

Add that README, plus the required provisions to exclude it from being synced to the plugin repo itself.

Testing Instructions

I've pushed this branch to my personal fork's trunk/. The README is found here; note that the workflow indeed hasn't been triggered by it.

@ockham ockham added the Gutenberg Plugin Issues or PRs related to Gutenberg Plugin management related efforts label Dec 19, 2024
@ockham ockham self-assigned this Dec 19, 2024
@ockham ockham marked this pull request as ready for review December 19, 2024 09:43
@ockham ockham requested a review from desrosj as a code owner December 19, 2024 09:43
@ockham ockham requested review from bph and sirreal December 19, 2024 09:44
Copy link

github-actions bot commented Dec 19, 2024

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: ockham <[email protected]>
Co-authored-by: sirreal <[email protected]>
Co-authored-by: bph <[email protected]>

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

Copy link
Member

@sirreal sirreal left a comment

Choose a reason for hiding this comment

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

I would just sync this file too, it will be helpful on both ends. I doubt it will cause any issues.

assets/README.md Outdated Show resolved Hide resolved
assets/README.md Outdated Show resolved Hide resolved
.github/workflows/sync-assets-to-plugin-repo.yml Outdated Show resolved Hide resolved
.github/workflows/sync-assets-to-plugin-repo.yml Outdated Show resolved Hide resolved
Copy link

github-actions bot commented Dec 19, 2024

Flaky tests detected in 510e4e6.
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/12412634829
📝 Reported issues:

Copy link
Contributor

@bph bph left a comment

Choose a reason for hiding this comment

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

The review.md is a great solution. Thank yiu.

Once back from Year-end vacation, I will see if there is also a place in the block editor handbook to add additional documentation there especially about the blueprint for Playground.

@ockham ockham merged commit c01cb99 into trunk Dec 19, 2024
62 checks passed
@ockham ockham deleted the add/asset-syncing-readme branch December 19, 2024 13:04
@github-actions github-actions bot added this to the Gutenberg 20.0 milestone Dec 19, 2024
@ockham
Copy link
Contributor Author

ockham commented Dec 19, 2024

I'll just leave this screenshot here in case we want to illustrate at some point what the approval screen looks like.

Screenshot 2024-12-19 at 14 05 05

@ockham
Copy link
Contributor Author

ockham commented Dec 19, 2024

The sync workflow ran; the README was synced to svn 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Gutenberg Plugin Issues or PRs related to Gutenberg Plugin management related efforts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants