This document guides a contributor through creating a release of nbconvert
.
Go to GitHub and assign all PRs that have been merged to milestones. This will be helpful when you update the changelog. If you go to this GitHub page <Github no milestones_> you will find all the PRs that currently have no milestones.
Review CONTRIBUTING.md
, particularly the testing and release sections.
You can remove all non-tracked files with:
git clean -xfdi
This would ask you for confirmation before removing all untracked files.
Make sure the dist/
folder is clean and avoid stale builds from previous attempts.
- Update the
changelog <changelog>
to account for all the PRs assigned to this milestone. - Update version number in
notebook/_version.py
. 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
sdist
andwheel
:python setup.py sdist python setup.py bdist_wheel
You can now test the
wheel
and thesdist
locally before uploading to PyPI. Make sure to use twine to upload the archives over SSL.twine upload dist/*
Push directly on master, including --tags separately
git push upstream git push upstream --tags
On nbviewer-deploy run invoke trigger_build and then once it's built on dockerhub run invoke doitall.
- If all went well, change the
notebook/_version.py
back adding the .dev
suffix.