[x] Branch: Starting from develop, create a release branch named release/2.0.5 for your changes.
[x] Version bump: Bump the version number in distributor.php, package-lock.json, package.json, readme.txt and tests/php/bootstrap.php if it does not already reflect the version being released. In distributor.php update both the plugin "Version:" property and the plugin DT_VERSION constant.
[x] New files: Ensure any new files, especially in the vendor folder, are correctly included in webpack.config.release.js.
[x] Changelog: Add/update the changelog in CHANGELOG.md.
[x] Props: Update CREDITS.md file with any new contributors, confirm maintainers are accurate.
[x] 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.
[x] Since tag updates: ensure @since tags indicate the new version, replacing x.x.x, n.e.x.t and other placeholders.
[x] Update this pull request's status from draft to ready to merge.
[x] 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 stable development version.
[x] Review: Do a review of the commit to the stable branch to ensure the contents of the diffs are as expected.
[x] Test: Check out the stable branch and test it locally to ensure everything works as expected. It is recommended that you rename the existing distributor directory and check out stable fresh because switching branches does not delete files. This can be done with git clone --single-branch --branch stable git@github.com:10up/distributor.git
[x] 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.
[x] Release: Create a new release, naming the tag and the release with the new version number, and targeting the stable 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.
[x] Check release: Wait for the Publish Release Action to complete, and then check the latest release to ensure that the ZIP has been attached as an asset. Download the ZIP and inspect the contents to be sure they match the contents of the stable branch.
[x] 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.
[x] 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.
develop
, create a release branch namedrelease/2.0.5
for your changes.distributor.php
,package-lock.json
,package.json
,readme.txt
andtests/php/bootstrap.php
if it does not already reflect the version being released. Indistributor.php
update both the plugin "Version:" property and the pluginDT_VERSION
constant.webpack.config.release.js
.CHANGELOG.md
.CREDITS.md
file with any new contributors, confirm maintainers are accurate.README.md
is geared toward GitHub andreadme.txt
contains WordPress.org-specific content. The two are slightly different.@since
tags indicate the new version, replacingx.x.x
,n.e.x.t
and other placeholders.draft
toready to merge
.develop
(or merge the Pull Request), then do the same fordevelop
intotrunk
(git checkout trunk && git merge --no-ff develop
).trunk
contains the stable development version.stable
branch to ensure the contents of the diffs are as expected.stable
branch and test it locally to ensure everything works as expected. It is recommended that you rename the existingdistributor
directory and check outstable
fresh because switching branches does not delete files. This can be done withgit clone --single-branch --branch stable git@github.com:10up/distributor.git
stable
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.stable
branch.Due date (optional)
field) and link to GitHub release (in theDescription
field), then close the milestone.X.Y.Z
do not make it into the release, update their milestone toX.Y.Z+1
,X.Y+1.0
,X+1.0.0
, orFuture Release
.