diff --git a/RELEASES.md b/RELEASES.md index 593714cfc48ba61d9bcfd28bce70e4c54289d9b8..bebc1c6cb7f2d53ef949492f1e4f4dee37d1ee4b 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -8,7 +8,7 @@ To create a new release of Jupyter Book, you need to do these things: 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. Install the [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator#installation). +3. Install the [github-activity](https://github.com/choldgraf/github-activity) package to generate a changelog. ## To create the release @@ -18,9 +18,9 @@ and check off the boxes as you complete items: ``` -- [ ] Ensure that there aren't any extra issues tackle in +- [ ] Ensure that there aren't any extra issues to tackle in [the milestone for the next release](https://github.com/jupyter/jupyter-book/milestones?direction=asc&sort=due_date) -- [ ] Label any major bug fixes, enhancements, and documentation improvements in the merged PRs and Issues +- [ ] Label any major bug fixes, enhancements, maintenance, and documentation improvements in the merged PRs - [ ] 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. @@ -33,22 +33,22 @@ and check off the boxes as you complete items: fill it in later. - [ ] 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. -- [ ] Create a release summary that github_changelog_generator will use - - * Create a new GitHub Issue - * In the Issue's Description field, add your release summary content - * Add the Issue Label "release-summary" - * Add the issue to the milestone of the version you just released - * Close the issue -- [ ] 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). +- [ ] **Generate a changelog** using the `github-activity` package. + + * See [here for `github-activity` installation instructions](https://github.com/choldgraf/github-activity#installation). * Run the generator with this command: ``` - github_changelog_generator jupyter/jupyter-book --token <<your-github-api-token>> + github-activity jupyter/jupyter-book --since <<latest-tag>> --until <<new-release-tag>> --auth <<your-github-api-token>> -o tmp.md ``` - * It will overwrite [`CHANGELOG.md`](https://github.com/jupyter/jupyter-book/blob/master/CHANGELOG.md). + * It will create a markdown changelog since the last jupyter-book release, and put it + in `tmp.md`. Copy the sections about **pull requests** and add it + to [`CHANGELOG.md`](https://github.com/jupyter/jupyter-book/blob/master/CHANGELOG.md). Ensure that the new version looks correct, then commit it to master. - * Copy the resulting markdown for the latest release into the GitHub release you just created. + * Create a release summary that describes the general changes that have been made, + add it to the changelog generated by `github-activity. Add this to the new section + of `CHANGELOG.md`. + * Commit the new changelog and merge it into master. +- [ ] Copy the resulting markdown for the latest release into the GitHub release you just created. - [ ] Celebrate! You've just released a new version of Jupyter Book! ``` \ No newline at end of file diff --git a/jupyter_book/book_template/_config.yml b/jupyter_book/book_template/_config.yml index 99deb08d20b83d12e5e68c7235af70810a044342..3e758345e47641a7f8cf1ea067c2fcda1ef5dbb4 100644 --- a/jupyter_book/book_template/_config.yml +++ b/jupyter_book/book_template/_config.yml @@ -148,4 +148,4 @@ plugins: - jekyll-scholar # Jupyter Book version - DO NOT CHANGE THIS. It is generated when a new book is created -jupyter_book_version: "0.6.3dev0" +jupyter_book_version: "0.6.3"