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

Improve gutenberg release docs to explain the plugin backporting process #47372

Merged
merged 3 commits into from
Jan 24, 2023

Conversation

talldan
Copy link
Contributor

@talldan talldan commented Jan 24, 2023

What?

Improves the gutenberg plugin release docs to explain the backporting process.

Why?

I noticed there are some errors and omissions in the docs around the backporting process for Gutenberg releases that has led to some mistakes (which were absolutely not the fault of the release coordinators—they couldn't know what isn't documented).

How?

Release candidate backports:

  • The 'Creating Release Candidate Patches' section is now moved to the chronologically correct part of the document (after the release candidate but before publishing the stable release), as this was being missed on a regular basis.
  • Explains the use of the Backport to Gutenberg RC label (which is a curious omission, considering there's a suggestion to use the npm run cherry-pick script).
  • Add a 'tip' on how to find the SHA of the merge commit
  • Mention that its good to check before the stable release whether anything needs to be backported.

Minor release backports

  • Fix an error where a 'major' release was called a 'minor' release.
  • Use the terminology 'minor' instead of 'point' release. I did this for two reasons. Firstly, this matches the terminology used on the github label. Secondly, WordPress uses unusual versioning, it isn't clear that '12.5' isn't a point version.
  • Explain usage of the Backport to Gutenberg Minor Release label in github.

Testing Instructions

Read the markdown file.

- Rename point to minor
- Fix incorrect usage of minor, normal releases are considered major
- Explain github labelling process for minor releases
@talldan talldan added the [Type] Project Management Meta-issues related to project management of Gutenberg label Jan 24, 2023
@talldan talldan self-assigned this Jan 24, 2023

Once the commits have been cherry-picked, remove the `Backport to Gutenberg RC` label and update the milestone to the current release for all cherry-picked PRs.

If you decide that the fixes deserve another release candidate before the stable version is published, create one by following the instructions above. Let other contributors know that a new release candidate has been released in the [`#core-editor` channel](https://wordpress.slack.com/messages/C02QB2JS7).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This last paragraph is confusing, but I've decided to leave it as it was.

Copy link
Contributor

Choose a reason for hiding this comment

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

It could use some refinement, but in general it's much clearer now.

@talldan talldan requested a review from mburridge January 24, 2023 05:16
Copy link
Contributor

@priethor priethor left a comment

Choose a reason for hiding this comment

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

Thanks @talldan ❤️


Once the commits have been cherry-picked, remove the `Backport to Gutenberg RC` label and update the milestone to the current release for all cherry-picked PRs.

If you decide that the fixes deserve another release candidate before the stable version is published, create one by following the instructions above. Let other contributors know that a new release candidate has been released in the [`#core-editor` channel](https://wordpress.slack.com/messages/C02QB2JS7).
Copy link
Contributor

Choose a reason for hiding this comment

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

It could use some refinement, but in general it's much clearer now.

@talldan talldan merged commit 8014a85 into trunk Jan 24, 2023
@talldan talldan deleted the update/release-docs branch January 24, 2023 06:10
@github-actions github-actions bot added this to the Gutenberg 15.1 milestone Jan 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Project Management Meta-issues related to project management of Gutenberg
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants