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

Release version 2.5.0 #137

Closed
17 tasks done
faisal-alvi opened this issue Jun 20, 2022 · 2 comments · Fixed by #138
Closed
17 tasks done

Release version 2.5.0 #137

faisal-alvi opened this issue Jun 20, 2022 · 2 comments · Fixed by #138
Assignees
Milestone

Comments

@faisal-alvi
Copy link
Member

faisal-alvi commented Jun 20, 2022

This issue is for tracking changes for the 2.5.0 release. Target release date: TBD - Late June 2022 or Early July 2022.

Pre-release steps

Release steps

  • Branch: Starting from develop, cut a release branch named release/2.5.0 for your changes.
  • Version bump: Bump the version number in package.json, readme.txt, and simple-local-avatars.php if it does not already reflect the version being released. Update both the plugin "Version:" property and the plugin SLA_VERSION constant in simple-local-avatars.php.
  • Changelog: Add/update the changelog in both CHANGELOG.md and readme.txt.(Recommendation to use: https://github.com/10up/changelog-generator)
  • Props: update CREDITS.md with any new contributors, confirm maintainers are accurate. (Recommendation to use: https://github.com/10up/credits-generator)
  • New files: Check to be sure any new files/paths that are unnecessary in the production version are included in .distignore.
  • Readme updates: Make any other readme changes as necessary. README.md is geared toward GitHub and readme.txt contains WordPress.org-specific content. The two are slightly different.
  • Make sure the release date is added in the CHANGELOG.md.
  • Merge: Make a non-fast-forward merge from your release branch to develop (or merge the pull request), then do the same for develop into trunk (git checkout trunk && git merge --no-ff develop). trunk contains the latest stable release.
  • Test: Run through common tasks while on trunk to be sure it functions correctly.
  • Push: Push your trunk branch to GitHub (e.g. git push origin trunk).
  • Release: Create a new release, naming the tag and the release with the new version number, and targeting the trunk branch. Paste the changelog from CHANGELOG.md into the body of the release and include a link to the closed issues on the milestone.
  • SVN: Wait for the GitHub Action to finish deploying to the WordPress.org repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
  • Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/simple-local-avatars/. This may take a few minutes.
  • Close the milestone: Edit the milestone with the release date (in the Due date (optional) field) and link to the GitHub release (in the Description field), then close the milestone.
  • Punt incomplete items: If any open issues or PRs which were milestoned for 2.5.0 do not make it into the release, update their milestone to the next milestone, or Future Release.

Post-release steps

@faisal-alvi faisal-alvi added this to the 2.5.0 milestone Jun 20, 2022
@faisal-alvi faisal-alvi self-assigned this Jun 20, 2022
@faisal-alvi faisal-alvi moved this to Incoming in Open Source Practice Jun 20, 2022
@faisal-alvi faisal-alvi moved this from Incoming to In Progress in Open Source Practice Jun 20, 2022
@faisal-alvi faisal-alvi mentioned this issue Jun 22, 2022
6 tasks
@jeffpaul
Copy link
Member

@faisal-alvi looks like you've got some nice additions to the release instructions here, would be great to update in https://github.com/10up/simple-local-avatars/blob/develop/CONTRIBUTING.md#release-instructions

Repository owner moved this from In Progress to Merged in Open Source Practice Jun 24, 2022
@faisal-alvi
Copy link
Member Author

Thanks, updated in #139.

@vikrampm1 vikrampm1 moved this from Merged to Done/Released in Open Source Practice Jun 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants