Skip to content

Document the cherry-picking automation#42932

Merged
adamziel merged 11 commits into
trunkfrom
docs/cherry-pick-automation
Aug 4, 2022
Merged

Document the cherry-picking automation#42932
adamziel merged 11 commits into
trunkfrom
docs/cherry-pick-automation

Conversation

@adamziel

@adamziel adamziel commented Aug 3, 2022

Copy link
Copy Markdown
Contributor

@adamziel adamziel self-assigned this Aug 3, 2022
@adamziel adamziel added [Type] Developer Documentation Documentation for developers Developer Experience Ideas about improving block and theme developer experience labels Aug 3, 2022
Comment thread docs/contributors/code/auto-cherry-picking.md Outdated
Comment thread docs/contributors/code/auto-cherry-picking.md Outdated
Comment thread docs/contributors/code/auto-cherry-picking.md Outdated
Comment thread docs/contributors/code/auto-cherry-picking.md Outdated
Comment thread docs/contributors/code/auto-cherry-picking.md

@ockham ockham left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks a lot for documenting this! Looks good; I had one minor nitpick (scattered across multiple comments 😅)

@gziolo gziolo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you so much for adding this document. I left my feedback on how we could improve the clarity of when this tool can be used. Anyway, I didn't see any blockers, and we can iterate on that.

Comment thread docs/contributors/code/release.md Outdated
Comment thread docs/contributors/code/release.md Outdated
Comment thread docs/contributors/code/release.md Outdated
Comment thread docs/toc.json Outdated
@@ -0,0 +1,73 @@
# Cherry-picking automation

The cherry-picking automation makes cherry-picking PRs into WordPress and Gutenberg release branches a breeze.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This document is also linked from the section that covers cherry-picking bugs for the Gutenberg plugin releases. As far as I know, we don't have a label for plugin releases, so we should create one as part of the process.

It would also be helpful to make it clear at the top of the document that, by default, it works with the current major WordPress release. Alternatively, we could add the logic that detects the label based on the name of the branch:

  • release/X.Y - plugin release
  • wp/X.Y - WP release

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

There's nothing major WP release specific in here – it works for the current git branch. I'll clarify that further.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The autodetection logic would be really nice, too! I'll leave it as a TODO note for anyone who wishes to pick that up

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think the confusion would get resolved with autodetection of the label that should be scanned.

Anyway, it's fine to leave a note with some examples how to approach that based on the scenario.

adamziel and others added 9 commits August 4, 2022 08:03

@gziolo gziolo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Excellent revisions ❤️

@adamziel adamziel merged commit 640856b into trunk Aug 4, 2022
@adamziel adamziel deleted the docs/cherry-pick-automation branch August 4, 2022 12:43
@github-actions github-actions Bot added this to the Gutenberg 13.9 milestone Aug 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Developer Experience Ideas about improving block and theme developer experience [Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants