This document is only meant for the project administrators, not users and developers.
Create a release branch
In the release branch:
update the version numbers in
update the conda recipe.
update the documentation with any new features or details about changes.
make linkcheckon the documentation and fix any redirected/broken links.
update the README and this release documentation, if necessary.
Build and upload the conda packages by following instructions in
Build the PyPI source distribution using
python setup.py sdist build.
Upload the source distribution to TestPyPI using
twine upload --repository testpypi dist/*. You will need to have the
twinepackage installed and set up your
$HOME/.pypirccorrectly. See details here.
Test the conda package by creating a new environment on different platforms with this package installed and then running SKLL examples or tests from a SKLL working copy. If the package works, then move on to the next step. If it doesn’t, figure out why and rebuild and re-upload the package.
Test the TestPyPI package by installing it as follows:
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple skll
Then run some SKLL examples or tests from a SKLL working copy. If the TestPyPI package works, then move on to the next step. If it doesn’t, figure out why and rebuild and re-upload the package.
Draft a release on GitHub while the Linux and Windows package tester builds are running.
Once both builds have passed, make a pull request with the release branch to be merged into
mainand request code review.
Once the build for the PR passes and the reviewers approve, merge the release branch into
Upload source and wheel packages to PyPI using
python setup.py sdist uploadand
python setup.py bdist_wheel upload
Make sure that the ReadTheDocs build for
Tag the latest commit in
mainwith the appropriate release tag and publish the release on GitHub.
Send an email around at ETS announcing the release and the changes.
Post release announcement on Twitter/LinkedIn.