Release Kwant 1.4
This is a checklist of the tasks that need to be completed to release Kwant 1.4.
Details for completing each step can be found in RELEASE.rst
Preflight
-
Check that all issues are resolved -
Ensure that all tests pass (waiting on def984b7) -
Inspect the documentation -
Update the whatsnew
file -
Verify that AUTHORS and mailmap are up to date
Make a release candidate for testing packaging
-
tag release candidate 1.4.0rc1 -
build source tarball and inspect/test it locally -
build documentation -
push tag and upload tarballs to the downloads website
Test packaging (each of these steps may be done in parallel)
If any of these steps reveal something that needs to be fixed in Kwant, you will need to fix the problems and start the "make a release candidate" step again.
Debian
Follow the steps for building the Debian packages from RELEASE.rst
-
release a version of tinyarray for Debian that builds on Python 3.7 (tinyarray needs a debian bugfix release anyway) -
update the required Python version to 3.5 -
update the Python dependencies to be in-line with setup.py -
remove dependency on liblapack-dev (perhaps also libblas-dev, but this will need to be checked) -
decide how to deal with qsymm, as it does not have a debian package but is required for building the docs (@jbweston suggests just patching out the qsymm parts of the docs)
Conda
-
Publish the release candidate source tarball "somewhere on the internet" (SOTI) -
open a PR to the conda-forge/kwant-feedstock repo on Github. Make sure to mark the PR as WIP so that it doesn't get merged in accidentally -
set the upstream tarball URL (in meta.yaml) to SOTI -
update the tarball hash in meta.yaml
-
-
See if the package builds
Publish the release
-
re-tag as final release (sans 'rcN') -
push the tag -
upload the source tarball to PyPI -
upload the source tarball to the Kwant website -
publish the debian packages -
publish the ubuntu packages -
create a new version of the Kwant conda-forge feedstock, and open a pull request to upstream -
upload the documentation to the Kwant website -
update the Kwant website to say that Conda is the preferred way to install Kwant on Windows
Announce the release
-
Write a short post summarizing the highlights on the Kwant website -
post to the Kwant mailing list
Working towards next release
-
add a whatsnew file for the next release -
tag this release with an a0
suffix -
push this tag to the official Kwant repository -
create a milestone for the next release
Edited by Anton Akhmerov