diff --git a/RELEASES.md b/RELEASES.md index c9dc5d8ce5aef0a024383d96ff0b3745e58995a6..a5ba0604adafb1116a22e94a0b0badf4c78391be 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -12,33 +12,30 @@ To create a new release, follow these steps: - Ensure that there aren't any extra issues to tackle in [the milestone for the next release](https://github.com/executablebooks/jupyter-book/milestones?direction=asc&sort=due_date) -- Remove `dev0` from the Jupyter Book version in `__init__.py` -- Create a "release commit": +- Bump `__init__.py` to the version for the release. Use + [semantic versioning](https://semver.org/) to decide what version to choose. + For example: ``` - git add jupyter_book - git commit -m "RLS: <version-number>" - git push upstream master + __version__ = "0.6.1" ``` -- [Create a new release](https://github.com/executablebooks/jupyter-book/releases/new) on GitHub. - The tag and title should be `v<version-number>`. For example, `v0.6.0`. -- Bump `__init__.py` to the next dev version. Increment the minor version and add `dev0` to it. e.g.: - - ``` - __version__ = "0.6.1dev0" - ``` -- Commit and push to master +- Create a "release commit": ``` git add jupyter_book - git commit -m "Dev version bump" + git commit -m "🚀RELEASE: <version-number>" git push upstream master ``` -- Confirm that a new version of the package [is posted to pypi](https://pypi.org/project/jupyter-book/) +- [Create a new release](https://github.com/executablebooks/jupyter-book/releases/new) on GitHub. + The tag and title should be `v<version-number>`. For example, `v0.6.1`. + - GitHub Actions will automatically deploy this release to PyPI using + [this configuration](https://github.com/executablebooks/jupyter-book/blob/master/.github/workflows/tests.yml#L86). + - Confirm that a new version of the package [is posted to pypi](https://pypi.org/project/jupyter-book/) - Add a changelog for the latest version by using `github-activity`: ``` github-activity executablebooks/jupyter-book -s <old-version-tag> -u <new-version-tag> ``` - and pasting the result into the release description on GitHub. + Paste the result into the release description on GitHub. +- You're done! 🎉 diff --git a/jupyter_book/__init__.py b/jupyter_book/__init__.py index e97457e022e956a3dee6845b23b10757614a6b15..ec2e6ff342913e92928b14a3a5a57792ee118dd8 100644 --- a/jupyter_book/__init__.py +++ b/jupyter_book/__init__.py @@ -5,7 +5,7 @@ from .toc import update_indexname, add_toctree from .directive.toc import TableofContents, SwapTableOfContents -__version__ = "0.7.2dev0" +__version__ = "0.7.2" def add_static_files(app, config):