RELEASES.md

Instructions for creating a new release

Jupyter-Book is hosted on the pypi repository. To create a new release of Jupyter Book, you need to do these things:

Before you start

1. Ensure that you have push access to the Jupyter Book pypi repository
2. Install the twine package. This is a package that helps you bundle and push new Python package distributions to pip.
3. Install the github-changelog-generator.

To create the release

1. Ensure that there aren't any extra issues tackle in the milestone for the next release
2. Ensure that the Jupyter Book version number is correct, and remove the dev0 part of the version number. Make a PR with the new number and merge into master.
3. Create a new distribution for Jupyter Book by following the twine release instructions
4. Confirm that the new version of Jupyter Book is posted to pypi
5. Create a new release on GitHub.
6. Bump the Jupyter Book version number to the next minor (or major) release and append dev0 to the end.
7. Generate the new changelog using the github-changelog-generator.

   • See here for github-changelog-generator installation instructions.

   • Run the generator with this command:

     github_changelog_generator sphinx-gallery/sphinx-gallery --token <<your-github-api-token>>
     

   • It will overwrite CHANGELOG.md. Ensure that the new version looks correct, then commit it to master.

8. Celebrate! You've just released a new version of Jupyter Book!