Doing a release¶
Doing a release of diffy
requires a few steps.
Bumping the version number¶
The next step in doing a release is bumping the version number in the software.
Update the version number in
diffy/__about__.py
.Set the release date in the Changelog.
Do a commit indicating this.
Send a pull request with this.
Wait for it to be merged.
Performing the release¶
The commit that merged the version number bump is now the official release
commit for this release. You will need to have gpg
installed and a gpg
key in order to do a release. Once this has happened:
Run
invoke release {version}
.
The release should now be available on PyPI and a tag should be available in the repository.
Verifying the release¶
You should verify that pip install diffy
works correctly:
>>> import diffy
>>> diffy.__version__
'...'
Verify that this is the version you just released.
Post-release tasks¶
Update the version number to the next major (e.g.
0.5.dev1
) indiffy/__about__.py
andAdd new Changelog entry with next version and note that it is under active development
Send a pull request with these items
Check for any outstanding code undergoing a deprecation cycle by looking in
diffy.utils
forDeprecatedIn**
definitions. If any exist open a ticket to increment them for the next release.