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/2.1.2 #382

Merged
merged 6 commits into from
Jun 20, 2024
Merged

Release/2.1.2 #382

merged 6 commits into from
Jun 20, 2024

Conversation

Sidsector9
Copy link
Member

@Sidsector9 Sidsector9 commented Jun 18, 2024

Release instructions

  • Branch: Starting from develop, cut a release branch named release/X.Y.Z for your changes.
  • Version bump: Bump the version number in safe-redirect-manager.php, package-lock.json, package.json, and readme.txt if it does not already reflect the version being released. In safe-redirect-manager.php update both the plugin "Version:" property and the plugin SRM_VERSION constant.
  • 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.
  • 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.
  • New files: Check to be sure any new files/paths that are unnecessary in the production version are included in .gitattributes.
  • 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 (e.g. https://github.com/10up/safe-redirect-manager/milestone/#?closed=1).
  • 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 WordPress.org. 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 X.Y.Z do not make it into the release, update their milestone to X.Y.Z+1, X.Y+1.0, X+1.0.0 or Future Release.

@Sidsector9 Sidsector9 marked this pull request as draft June 18, 2024 14:10
@Sidsector9 Sidsector9 marked this pull request as ready for review June 18, 2024 15:30
@Sidsector9 Sidsector9 removed the request for review from dkotter June 18, 2024 15:30
@Sidsector9 Sidsector9 self-assigned this Jun 18, 2024
@jeffpaul jeffpaul added this to the 2.1.2 milestone Jun 18, 2024
Copy link
Member

@jeffpaul jeffpaul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for handling the release!

@Sidsector9 Sidsector9 merged commit 5afd5f0 into develop Jun 20, 2024
14 checks passed
@Sidsector9 Sidsector9 deleted the release/2.1.2 branch June 20, 2024 06:20
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 this pull request may close these issues.

2 participants