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.2.5 #208

Closed
17 tasks done
jeffpaul opened this issue Jun 26, 2024 · 0 comments · Fixed by #209
Closed
17 tasks done

Release version 2.2.5 #208

jeffpaul opened this issue Jun 26, 2024 · 0 comments · Fixed by #209
Assignees
Milestone

Comments

@jeffpaul
Copy link
Member

jeffpaul commented Jun 26, 2024

Describe your question

This issue is for tracking changes for the 2.2.5 release. Target release date: June 2024.

Release steps

  • Branch: Starting from develop, cut a release branch named release/2.2.5 for your changes.
  • Version bump: Bump the version number in readme.txt, safe-svg.php, package.json and package-lock.json if it does not already reflect the version being released. In safe-svg.php update both the plugin "Version:" property and the plugin SAFE_SVG_VERSION constant.
  • Changelog: Add/update the changelog in CHANGELOG.md and readme.txt.
  • Props: Update CREDITS.md with any new contributors, confirm maintainers are accurate.
  • 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.
  • 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, ensuring you pull the most recent changes into develop first (git checkout develop && git pull origin develop && git checkout trunk && git merge --no-ff develop). trunk contains the stable development version.
  • Push: Push your trunk branch to GitHub (e.g. git push origin trunk).
  • Compare trunk to develop to ensure no additional changes were missed.
  • Test the pre-release ZIP locally by downloading it from the Build release zip action artifact and installing it locally. Ensure this zip has all the files we expect, that it installs and activates correctly and that all basic functionality is working.
  • Either perform a regression testing utilizing the available Critical Flows and Test Cases or if end-to-end tests cover a significant portion of those Critical Flows then run e2e tests. Only proceed if everything tests successfully.
  • 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. The release should now appear under releases.
  • 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/safe-svg/. This may take a few minutes.
  • Close milestone: Edit the milestone with release date (in the Due date (optional) field) and link to GitHub release (in the Description field), then close the milestone.
  • Punt incomplete items: If any open issues or PRs which were milestoned for 2.2.5 do not make it into the release, update their milestone to 2.3.0 or Future Release.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@jeffpaul jeffpaul added this to the 2.2.5 milestone Jun 26, 2024
@jeffpaul jeffpaul self-assigned this Jun 26, 2024
@jeffpaul jeffpaul mentioned this issue Jun 26, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant