Skip to content

Improve plugin release checklist and documentation #70808

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 21, 2025
Merged

Improve plugin release checklist and documentation #70808

merged 1 commit into from
Jul 21, 2025

Conversation

t-hamano
Copy link
Contributor

@t-hamano t-hamano commented Jul 21, 2025 •
edited
Loading

What?

This PR improves the issue template and documentation to make it easier to release the Gutenberg plugin release.

Why?

I’ll be leading the Gutenberg release for the first time in 21.3, but I want to make sure that contributors like me who are leading a release for the first time don’t get lost.

How?

Issue Template

https://github.com/WordPress/gutenberg/issues/new?template=New_release.md

  • Add a title to the template for creating a release checklist issue.
  • Clarify the text that needs to be updated every time a release is made by using {UPPER_CASE} format
  • Link checklist items to relevant sections in the documentation whenever possible.
  • Fixes incorrect anchor links

Documentation

https://developer.wordpress.org/block-editor/contributors/code/release/

  • Better markdown formatting
  • Fixes incorrect anchor links

Testing Instructions

Check the new issue template:

https://github.com/WordPress/gutenberg/blob/docs/update-release-process/.github/ISSUE_TEMPLATE/New_release.md

Check the new document:

https://github.com/WordPress/gutenberg/blob/docs/update-release-process/docs/contributors/code/release.md

t-hamano
t-hamano commented Jul 21, 2025
View reviewed changes
docs/contributors/code/release.md
Comment on lines 485 to +493
2. `npx lerna updated`
> Example
>
> ```shell
> npx lerna updated
> @wordpress/e2e-tests
> @wordpress/jest-preset-default
> @wordpress/scripts
> lerna success found 3 packages ready to publish
> ```
Example:
```shell
npx lerna updated
@wordpress/e2e-tests
@wordpress/jest-preset-default
@wordpress/scripts
lerna success found 3 packages ready to publish
```
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 formatting doesn't seem to work properly on the handbook page:

image

Let's try to remove the quotes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looks better now.

https://developer.wordpress.org/block-editor/contributors/code/release/#standalone-bugfix-package-releases

image

@t-hamano t-hamano marked this pull request as ready for review July 21, 2025 03:36
@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 21, 2025 •
edited
Loading

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>

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

@t-hamano t-hamano added the [Type] Project Management Meta-issues related to project management of Gutenberg label Jul 21, 2025
@github-actions GitHub Actions
Copy link

Flaky tests detected in b0a1cd5.
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/16407703365
📝 Reported issues:

@t-hamano t-hamano merged commit afc0259 into trunk Jul 21, 2025
67 of 76 checks passed
@t-hamano t-hamano deleted the docs/update-release-process branch July 21, 2025 06:05
@github-actions github-actions bot added this to the Gutenberg 21.3 milestone Jul 21, 2025
adamsilverstein pushed a commit to adamsilverstein/gutenberg that referenced this pull request Jul 21, 2025
@t-hamano @Mamaduka @adamsilverstein
Improve plugin release checklist and documentation (WordPress#70808)
191a899 
Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
USERSATOSHI pushed a commit to USERSATOSHI/gutenberg that referenced this pull request Jul 23, 2025
@t-hamano @Mamaduka @USERSATOSHI
Improve plugin release checklist and documentation (WordPress#70808)
0caeb43 
Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
@priethor
Copy link
Contributor

Thanks @t-hamano !

There is currently plenty of release documentation, which is great, but on the other hand, one recurring piece of feedback I hear from first-timers is that it can be overwhelming. Is there anything you would simplify both in the docs and the issue template?

@t-hamano
Copy link
Contributor Author

Hi @priethor, To be honest, it was a lot of work to read every section of the documentation to prepare for the release 😅

I believe we can simplify the documentation a bit more while still keeping the information accurate. I'll consider submitting a PR to update the documentation after the 21.3 release is complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mamaduka Mamaduka Mamaduka approved these changes

@talldan talldan Awaiting requested review from talldan

@priethor priethor Awaiting requested review from priethor

@desrosj desrosj Awaiting requested review from desrosj desrosj is a code owner

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

@juanmaguitar juanmaguitar Awaiting requested review from juanmaguitar juanmaguitar is a code owner

@fabiankaegy fabiankaegy Awaiting requested review from fabiankaegy fabiankaegy is a code owner

@ndiego ndiego Awaiting requested review from ndiego ndiego is a code owner

Assignees
No one assigned
Labels
[Type] Project Management Meta-issues related to project management of Gutenberg
Projects
None yet
Milestone
Gutenberg 21.3
Development

Successfully merging this pull request may close these issues.
3 participants
@t-hamano @priethor @Mamaduka