10up/Ad-Refresh-Control

Release version 1.0.2

jeffpaul opened this issue · 0 comments

This issue is for tracking changes for the 1.0.2 release. Target release date: TBD November 2020.

Pre-release steps

  • NEEDED: review #22, resolve any issues, and merge.
  • NEEDED: review #23, resolve any issues, and merge.
    - [ ] NEEDED: review #24, resolve any issues, and merge.

Release steps

  • Branch: Starting from develop, cut a release branch named release/1.0.2 for your changes.
  • Version bump: Bump the version number in ad-refresh-control.php, package.json, and readme.txt if it does not already reflect the version being released. In ad-refresh-control.php update both the plugin "Version:" property and the plugin AD_REFRESH_CONTROL_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.
  • 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 .distignore.
  • 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: While still on the trunk branch, test for functionality locally.
  • 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](https://github.com/10up/Ad-Refresh-Control/milestone/5?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 https://wordpress.org/plugins/ad-refresh-control/. This may take a few minutes.
  • Close the 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 1.0.2 do not make it into the release, update their milestone to 1.1.0, or Future Release.
  • Version bump (again): In the develop branch (cd ../ && git checkout develop) bump the version number in ad-refresh-control.php, package.json, and readme.txt to 1.0.3-dev. It's okay if the next release might be a different version number; that change can be handled right before release in the first step, as might also be the case with @since annotations.