Skip to content
Snippets Groups Projects
Unverified Commit d25bbf7d authored by Chris Holdgraf's avatar Chris Holdgraf Committed by GitHub
Browse files

new release and updating instructions (#387)

new release and updating instructions
parents 1ed81463 0fd791f7
No related branches found
No related tags found
No related merge requests found
......@@ -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
......@@ -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"
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