Skip to content

ReleaseGuideline

Mike Taves edited this page Jul 10, 2024 · 3 revisions

Here are the steps to publishing a new release.

Prepare local develop branch:

git fetch origin
git checkout develop
git pull

Decide to increment either the major, minor and/or micro version numbers. Most of the time this will be the minor number. Now create a release branch based on the new version:

git checkout -b rel-0.2.0

Merge everything from develop, keep default "Merge ..." message:

git merge -X theirs origin/develop

Edit pypestutils/version.py like this:

- __version__ = "0.1.1.dev0"
+ __version__ = "0.2.0"

Edit CHANGELOG.md following Keep a Changelog as a guideline. To help populate changelog items, see https://github.com/pypest/pypestutils/compare/v0.1.0...develop using the previous version as a reference.

Create a commit for the release:

git add pypestutils/version.py
git add CHANGELOG.md
git commit -m "Release 0.2.0"
git push origin rel-0.2.0

On GitHub, create a new pull request, which should look like this:

Screenshot from 2023-10-27 12-39-33

Make sure tests pass, and (if needed) get feedback from others if the changelog looks ok. When ready, click "Squash and merge" should be good to go.

Clone this wiki locally