Skip to content
Snippets Groups Projects
Commit d5256e5c authored by Chris Holdgraf's avatar Chris Holdgraf
Browse files

release info

parent c14942a0
No related branches found
No related tags found
No related merge requests found
......@@ -16,12 +16,14 @@ To create a new release of Jupyter Book, you need to do these things:
[the milestone for the next release](https://github.com/jupyter/jupyter-book/milestones?direction=asc&sort=due_date)
2. Ensure that the [Jupyter Book version number](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/__init__.py)
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](https://twine.readthedocs.io/en/latest/#using-twine)
4. Confirm that the new version of Jupyter Book [is posted to pypi](https://pypi.org/project/jupyter-book/)
5. Bump the [Jupyter Book version number](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/__init__.py) to
5. Create a new [release on GitHub](https://github.com/jupyter/jupyter-book/releases).
6. Bump the [Jupyter Book version number](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/__init__.py) to
the next minor (or major) release and append `dev0` to the end.
6. Generate the new changelog using the `github-changelog-generator`.
7. Generate the new changelog using the `github-changelog-generator`.
* See [here for `github-changelog-generator` installation instructions](https://github.com/github-changelog-generator/github-changelog-generator#installation).
* Run the generator with this command:
......@@ -30,4 +32,4 @@ To create a new release of Jupyter Book, you need to do these things:
```
* It will overwrite [`CHANGELOG.md`](https://github.com/jupyter/jupyter-book/blob/master/CHANGELOG.md).
Ensure that the new version looks correct, then commit it to master.
7. Celebrate! You've just released a new version of Jupyter Book!
\ No newline at end of file
8. Celebrate! You've just released a new version of Jupyter Book!
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment