-
Notifications
You must be signed in to change notification settings - Fork 143
Add release documentation #138
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
Merged
+45
−0
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
677f9fd
Initial release documentation draft
JustinyAhin 400f961
Update Releasing-the-plugin.md
JustinyAhin 5a33d3d
Update Releasing-the-plugin.md
JustinyAhin 570209b
Update Releasing-the-plugin.md
JustinyAhin 5419b35
Add section for module headers fields translation
JustinyAhin 2354a7f
Add additional details to the readme.txt update section
JustinyAhin 0bf431b
Update docs/Releasing-the-plugin.md
JustinyAhin f664668
Update docs/Releasing-the-plugin.md
JustinyAhin e5e5b18
Add details about changing `next` occurences to the release version n…
JustinyAhin a12e051
Update docs/Releasing-the-plugin.md
JustinyAhin 8eb003f
Update release publishing section
JustinyAhin 7b08402
Update Releasing-the-plugin.md
JustinyAhin 5380ce5
Update docs/Releasing-the-plugin.md
JustinyAhin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # Releasing the performance plugin | ||
|
|
||
| This document describes the steps to release the Performance plugin. | ||
|
|
||
| ## Preparing the release | ||
|
|
||
| ### Create a local release branch | ||
|
|
||
| Before making any changes, create a local branch `release/{milestoneName}` from latest `trunk`, where `{milestoneName}` is the name of the milestone (which should match the release version). For example, if the milestone is `1.2.0`, name the branch `release/1.2.0`. | ||
|
|
||
| ### Update the version number | ||
|
|
||
| The version number needs to be updated in the following files: | ||
|
|
||
| - package.json | ||
| - load.php | ||
| - readme.txt | ||
|
|
||
JustinyAhin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| In addition to those locations, do a global search and replace across the entire codebase to replace any occurrence of `n.e.x.t` with the version number. This ensures any code annotated with the "next" release will now have its proper version number on it. The only exception to this are pre-releases, such as a beta or RC: For those, the stable version number should be used. For example, if the milestone is `1.2.0-beta.2`, the version in e.g. `@since` annotations in the codebase should still be `1.2.0`. | ||
|
|
||
| ### Update translation strings | ||
|
|
||
| The module headers from the plugin have to be translated using a separate `module-i18n.php` file which can be automatically generated and updated. Run `npm run translations` to update the file to reflect the latest available modules. | ||
|
|
||
| ### Update readme.txt | ||
|
|
||
| Run `npm run readme -- -m "{milestoneName}"` to update the readme.txt file with the release changelog, where `{milestoneName}` is the name of the milestone. For example, if the milestone is `1.2.0`, the command needs to be `npm run readme -- -m "1.2.0"`. | ||
|
|
||
| After running the command, check the readme.txt file to ensure the new changelog for the release has been added. Also review its changelog entries for whether they make sense and are understandable. | ||
|
|
||
| ### Open a pull request | ||
|
|
||
| Push your local release branch to the GitHub repository and open a pull request against `trunk`. Make sure to tag at least 2 plugin maintainers to request a review. Once the pull request is approved by at least 2 plugin maintainers, the pull request can be merged. | ||
|
|
||
| If this is a major or minor release, please keep the release branch around since that branch can be used to later create patch releases from the same state of the codebase. | ||
|
|
||
| ## Publishing the release | ||
|
|
||
| Once the above pull request has been merged, let the other maintainers know on [Slack](https://wordpress.slack.com/archives/performance) that no new commits or pull requests must be added to the branch due to the release process. Then, make sure that all GitHub actions successfully pass for the target branch (e.g. [for `trunk`](https://github.com/WordPress/performance/actions?query=branch%3Atrunk)). | ||
|
|
||
JustinyAhin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| After that, [create a new release tag for the plugin on GitHub](https://github.com/WordPress/performance/releases/new). The release tag should have the same name as the corresponding milestone used earlier, and it should be created from the `trunk` branch (unless this is for a patch release, in which case it should be created from the corresponding `release/...` branch). Finally, add the changelog (it can be found in the readme.txt file) to the release description and create the release. | ||
|
|
||
| Once a new version is released on GitHub, the plugin will be deployed to the [WordPress.org repository](https://wordpress.org/plugins/performance-lab/) using [this action](../.github/workflows/deploy-dotorg.yml). | ||
|
|
||
| At this point, test the update process from your WordPress site, getting the plugin from wordpress.org. You can then share on [Slack](https://wordpress.slack.com/archives/performance) that the new release has been published and that committing may continue. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.