-
Notifications
You must be signed in to change notification settings - Fork 33
GitHub Actions: Add Release and Bump Version workflows #2923
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
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
9191832
Make the e2e and integration tests workflows reusable
vaurdan 5be24e4
Add release-plugin workflow
vaurdan 16cafe0
Add bump version workflow
vaurdan 7ddb46d
Tweak binaries to work within Github Actions
vaurdan 21ce829
Add new Release check-list.
vaurdan e44613e
Update release-template-new.md
vaurdan 3d0c671
Apply code review feedback
vaurdan 127a354
Remove unwanted file
vaurdan fc29b7d
Merge branch 'develop' into add/release-bump-version-workflows
vaurdan c9d748d
Add missing period.
vaurdan 26f4756
Merge remote-tracking branch 'origin/add/release-bump-version-workflo…
vaurdan 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,68 @@ | ||
| --- | ||
| name: Release template [NEW] | ||
| about: Internally used for new releases | ||
| title: Release wp-parsely x.y.z | ||
| labels: 'Type: Maintenance' | ||
| --- | ||
|
|
||
| This is an issue for tracking the next `wp-parsely` release. This ticket is to be opened the week before the actual release, so we have enough time to complete all the related tasks. | ||
|
|
||
| The actual release of the plugin should be done on Mondays so we can catch the Tuesday WordPress VIP release window. | ||
|
|
||
| ## Before releasing | ||
|
|
||
| **1. Merge all outstanding work** | ||
| - [ ] Merge any outstanding PRs due for this release to the target branch (usually `develop`). | ||
| - [ ] Verify that all important PRs have an appropriate `Changelog` tag. PRs without a `Changelog` tag won't be added to the changelog. | ||
|
|
||
| **2. Conduct additional testing** | ||
| We've got automated testing in place and also test under our local development environment during development. For impactful releases we should also: | ||
| - [ ] Conduct an additional [smoke test](https://github.com/Parsely/wp-parsely/blob/develop/docs/TESTING.md#manual-smoke-test) under our local development environment. | ||
| - [ ] Test under a regular non-local WordPress installation. | ||
| - [ ] Test under a real WordPress VIP environment. | ||
|
|
||
| **3. Communicate** | ||
| - [ ] Inform Parse.ly support of the upcoming release. | ||
|
|
||
| The following additional tasks might be needed depending on the release and its impact: | ||
| - [ ] Write any needed internal documentation. | ||
| - [ ] Write an internal P2 post about the release (to be posted immediately so folks are aware of the release ahead of time). | ||
| - [ ] Write a WordPress VIP Lobby post about the release (to be posted immediately to preannounce next week's VIP release - don't forget to get someone to proofread!). | ||
| - [ ] Prepare any public documentation (to be posted after the WordPress.org release). | ||
vaurdan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Release process | ||
|
|
||
| **1. Update version numbers and changelog** | ||
| - [ ] [Run the Bump wp-parsely version](https://github.com/Parsely/wp-parsely/actions/workflows/bump-version.yml) GitHub Action to update the version numbers in the plugin files. Use the branch you want to release from (usually `develop`). | ||
| - [ ] Verify that the generated PR looks correct. You can amend it with new commits if needed. | ||
| - [ ] Merge the PR into the target branch (usually `develop`). | ||
vaurdan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| **2. Merge develop into trunk** | ||
| - [ ] [Create a PR](https://github.com/Parsely/wp-parsely/compare/trunk...develop?quick_pull=1&title=Release+wp-parsely+x.y.z&body=This+PR+merges+the+`develop`+branch+into+the+`trunk`+branch+in+order+to+release+wp-parsely+x.y.z.) that merges the target branch (usually `develop`) into `trunk`, named _Release wp-parsely x.y.z_. | ||
| - [ ] Merge the PR into `trunk`. | ||
|
|
||
| **3. Create Release and Deploy to WordPress.org** | ||
| - [ ] Check if the `develop` and `trunk` branches built successfully. You can check it in the [GitHub Actions](https://github.com/Parsely/wp-parsely/actions/workflows/build-plugin.yml) tab. | ||
| - [ ] [Run the Release wp-parsely](https://github.com/Parsely/wp-parsely/actions/workflows/release-plugin.yml) GitHub Action, on the `trunk-built` branch, inputting the new version number, and without selecting Dry run. | ||
| - [ ] Check the action logs for any errors. If there are any, fix them and rerun the action. | ||
| - [ ] Check the new release on the [GitHub releases page](https://github.com/Parsely/wp-parsely/releases) and verify that it is correct. | ||
| - [ ] Verify that the release was successful by checking the [WordPress.org plugin page](https://wordpress.org/plugins/wp-parsely/). | ||
|
|
||
| ## After releasing | ||
|
|
||
| **1. Communicate** | ||
| - [ ] If needed, update the public documentation. | ||
| - [ ] Inform the concerned Slack channels about the new release, also preannouncing the WordPress VIP release. | ||
|
|
||
| **2. Merge trunk back into develop** | ||
| - [ ] [Create a PR](https://github.com/Parsely/wp-parsely/compare/develop...trunk?quick_pull=1&title=Merge+trunk+into+develop+after+the+wp-parsely+x.y.z+release&body=This+PR+merges+the+`trunk`+branch+into+the+`develop`+branch+after+the+release+of+wp-parsely+x.y.z.) that merges `trunk` into `develop`, named _Merge trunk into develop after the wp-parsely x.y.z release_. | ||
| - [ ] Merge the PR into `develop`. | ||
|
|
||
| **3. Manage milestones** | ||
| - [ ] Close the current milestone. | ||
| - [ ] If needed, open a new milestone for the next release. | ||
|
|
||
| **4. Release to other platforms** | ||
| - [ ] Update the `vip-go-mu-plugins` submodule to the latest version. | ||
| - [ ] Release the plugin for WordPress VIP. | ||
| - [ ] Release the plugin for WordPress.com. | ||
vaurdan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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
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
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
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
Oops, something went wrong.
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.