Release version 2.2.6
Closed this issue · 0 comments
dkotter commented
This issue is for tracking changes for the 2.2.6 release. Target release date: August 2024.
Release steps
- Branch: Starting from
develop
, cut a release branch namedrelease/2.2.6
for your changes. - Version bump: Bump the version number in
readme.txt
,safe-svg.php
,package.json
andpackage-lock.json
if it does not already reflect the version being released. Insafe-svg.php
update both the plugin "Version:" property and the pluginSAFE_SVG_VERSION
constant. - Changelog: Add/update the changelog in
CHANGELOG.md
andreadme.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 andreadme.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 fordevelop
intotrunk
, ensuring you pull the most recent changes intodevelop
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
todevelop
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 fromCHANGELOG.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 theDescription field
), then close the milestone. - Punt incomplete items: If any open issues or PRs which were milestoned for
2.2.6
do not make it into the release, update their milestone to2.3.0
orFuture Release
.