-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Docs: Update release.md #29091
Docs: Update release.md #29091
Conversation
Size Change: 0 B Total Size: 1.38 MB ℹ️ View Unchanged
|
894c253
to
fbdff1a
Compare
The release script will create a `git` tag for the release and push it to GitHub. This triggers a GitHub workflow that builds the plugin, creates a release draft (based on the Changelog), and attaches the plugin zip. This will take a couple of minutes. You will then find the release draft at https://github.com/WordPress/gutenberg/releases. You can edit it further (but note that the changes won't be propagated to `changelog.txt`). Once you're happy with it, press the 'Publish' button. | ||
|
||
If you're releasing a stable version (rather than an RC), this will trigger a GitHub action that will upload the plugin to the WordPress.org plugin repository (SVN). This action needs approval by a member of the [`gutenberg-core` team](https://github.com/orgs/WordPress/teams/gutenberg-core). Locate the ["Upload Gutenberg plugin to WordPress.org plugin repo" workflow](https://github.com/WordPress/gutenberg/actions/workflows/upload-release-to-plugin-repo.yml) for the new version, and have it [approved](https://docs.github.com/en/actions/managing-workflow-runs/reviewing-deployments#approving-or-rejecting-a-job). | ||
|
||
### Manual Release Process |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel at some point we should remove that part from the docs. It's already out of sync with what we do automatically and it just confuses people right now. It had its moment of glory :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "Manual Release Process" section? Yeah, agree. It makes the file look unnecessarily (and scarily) long, and it's probably just as good if it's all encoded in our workflow files and helper scripts.
We can remove it after #28138 has landed maybe?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
To reflect the updated release process.
There's one functional change to the release GH workflow included in this PR: Rather than publishing the release right away, only create the draft, and let a human publish it.
The reason for this is twofold:
Changes to
release.md
thus include:gutenberg-core
team needs to approve the upload.Two days-> One week between RC and stable release.Finally, instructions in the
release.js
script are updated accordingly. (Keep in mind that that script is slated for removal once #28138 lands).