Release version 2.1.0
Closed this issue · 0 comments
jeffpaul commented
This issue is for tracking changes for the 2.1.0 release. Target release date: TBD.
Pre-release steps
- Complete review of PR #41, resolve issues/merge ...or... punt to next release
- Complete review of PR #57, resolve issues/merge ...or... punt to next release
- Complete review of PR #78, resolve issues/merge ...or... punt to next release
Release steps
- Branch: Starting from
develop
, cut a release branch namedrelease/2.1.0
for your changes. - Version bump: Bump the version number in
src/bootstrap.php
if it does not already reflect the version being released. - Changelog: Add/update the changelog in
CHANGELOG.md
. - Props: Update
CREDITS.md
file with any new contributors, confirm maintainers are accurate - Readme updates: Make any other readme changes as necessary in
README.md
. - Merge: Make a non-fast-forward merge from your release branch to
develop
(or merge the pull request), then do the same fordevelop
intomaster
(git checkout master && git merge --no-ff develop
).master
contains the stable development version. - Push: Push your trunk branch to GitHub (e.g.
git push origin master
). - Wait for build: Head to the Actions tab in the repo and wait for it to finish if it hasn't already. If it doesn't succeed, figure out why and start over.
- Check the build: Check out the
master
branch and test for functionality locally. - Release: Create a new release, naming the tag and the release with the new version number, and targeting the
master
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. - 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.1.0
do not make it into the release, update their milestone to2.2.0
orFuture Release
.