This repository has been archived by the owner on Feb 4, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 83
Release Checklist
Frerich Raabe edited this page Sep 10, 2018
·
2 revisions
- Review the list of Pull Requests to see whether there's anything nice ready to be included in the release.
- Ensure that the current CI builds are all green
- Review the
CHANGELOG.mod
file for potentially missing items. - Create a 'Bump version number' commit, consisting of two changes:
- Bump the
VERSION
constant inclcache/__main__.py
; remember that clcache uses semantic versioning. - Replace the
## Upcoming release
marker at the top ofCHANGELOG.mod
with the new version and date, e.g.## clcache 4.1.0 (2017-05-23)
.
- Bump the
- Run
git tag vX.Y.Z
to assign a new tag to the commit. - Run
git push && git push --tags
to publish the commit and trigger package builds - Check the AppVeyor build and wait for a job to finish.
- Download the
SHA256SUM
,clcache-X.Y.Z.zip
andclcache.X.Y.Z.nupkg
files. - Draft a new release:
- use
clcache vX.Y.Z
for the release name - mention significant changes; at the very least, reference the
CHANGELOG.md
file for detailed list of changes - Attach the
SHA256SUM
,clcache-X.Y.Z.zip
andclcache.X.Y.Z.nupkg
files to the release. - Publish the release!
- use
- Publish the new version of the clcache PyPI package. A tutorial is available for this, the rusty three-line guide is to run (in a virtual environment):
pip install wheel twine python setup.py bdist_wheel sdist twine upload dist\*
- Create a 'Post-release' commit, consisting of two changes:
- Adjust the
VERSION
constant inclcache/__main__.py
, append-dev
to the version number (e.g.4.1.0-dev
). - Add
at the top of## Upcoming release * Nothing yet!
CHANGELOG.md
file to hold future release notes. - Adjust the
- Push the new 'Post-release' commit