10up/eight-day-week

Release version 1.2.3

Closed this issue · 0 comments

dkotter commented

This issue is for tracking changes for the 1.2.3 release. Target release date: September 2023

Release steps

  • Branch: Starting from develop, cut a release branch named release/1.2.3 for your changes.
  • Version bump: Bump the version number in eight-day-week.php, package.json, package-lock.json and readme.txt if it does not already reflect the version being released. Update both the plugin "Version:" property and the plugin EDW_VERSION constant in eight-day-week.php.
  • Changelog: Add/update the changelog in both readme.txt and CHANGELOG.md.
  • Props: update CREDITS.md file 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 .gitattributes.
  • 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, then do the same for develop into trunk (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
  • Release: Create a new release, naming the tag and the release with the new version number. Paste the changelog from CHANGELOG.md into the body of the release and include a link to the closed issues on the milestone (e.g. https://github.com/10up/eight-day-week/milestone/10?closed=1). Close 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/eight-day-week-print-workflow/. 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 1.2.3 milestone.
  • Punt incomplete items: If any open issues or PRs which were milestoned for 1.2.3 do not make it into the release, update their milestone to 1.3.0 or Future Release.