Making a release as a maintainer¶
This document guides a maintainer through creating a release of the Jupyter console.
Check installed tools¶
CONTRIBUTING.rst. Make sure all the tools needed are properly
Clean the repository¶
Remove all non-tracked files with:
git clean -xfdi
This will ask you for confirmation before removing all untracked files. Make
dist/ folder is clean and does not contain any stale builds from
Create the release¶
Set Environment variables
Set environment variables to document current release version, and git tag:
Update version number in
jupyter_console/_version.py. Make sure that a valid PEP 440 version is being used.
Commit and tag the release with the current version number:
git commit -am "release $VERSION" git tag $VERSION
You are now ready to build the
python setup.py sdist --formats=zip,gztar python setup.py bdist_wheel
You can now test the
sdistlocally before uploading to PyPI. Make sure to use twine to upload the archives over SSL.
twine upload dist/*
If all went well, change the
jupyter_console/_version.pyto the next release.
Push directly on master, not forgetting to push