Release (#193)

Release

RELEASES.md

@@ -3,17 +3,33 @@
 Jupyter-Book is [hosted on the pypi repository](https://pypi.org/project/jupyter-book/).
 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](https://pypi.org/project/jupyter-book/)
 2. Install [the twine package](https://twine.readthedocs.io/en/latest/). This is a package that helps you
    bundle and push new Python package distributions to pip.
-3. Ensure that new additions, bugs, etc for this release are updated in
-   [the CHANGELOG](https://github.com/jupyter/jupyter-book/blob/master/CHANGELOG.md)
- release of Jupyter Book has
-4. Ensure that the [Jupyter Book version number](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/__init__.py)
+3. Install the [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator#installation).
+
+## To create the release
+
+1. Ensure that there aren't any extra issues tackle in
+   [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.
-5. Create a new distribution for Jupyter Book by
+   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)
-6. Confirm that the new version of Jupyter Book [is posted to pypi](https://pypi.org/project/jupyter-book/)
-7. Bump the [Jupyter Book version number](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/__init__.py) to
+4. Confirm that the new version of Jupyter Book [is posted to pypi](https://pypi.org/project/jupyter-book/)
+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.
-9. Celebrate! You've just released a new version of Jupyter Book!
+7. Generate the new changelog using the `github-changelog-generator`.
\ No newline at end of file
+   * See [here for `github-changelog-generator` installation instructions](https://github.com/github-changelog-generator/github-changelog-generator#installation).
+   * Run the generator with this command:
+    
+     ```
+     github_changelog_generator sphinx-gallery/sphinx-gallery --token <<your-github-api-token>>
+     ```
+   * 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.
+8. Celebrate! You've just released a new version of Jupyter Book!
\ No newline at end of file

jupyter_book/__init__.py

 """Build an online book using Jupyter Notebooks and Jekyll."""
-__version__ = "0.4.3dev0"
+__version__ = "0.5.0"

jupyter_book/book_template/content/intro.md

@@ -37,7 +37,7 @@ Here are a few links of interest:
 To install the Jupyter Book command-line interface (CLI), use `pip`!
 
 ```
-pip install jupyter_book
+pip install jupyter-book
 ```
 
 ### Create a new book