|
1 | 1 | # Instructions for creating a new release
|
2 | 2 |
|
3 |
| -Spinx-Copybutton is [hosted on the pypi repository](https://pypi.org/project/sphinx-togglebutton/). |
| 3 | +Spinx-Toggle is [hosted on the pypi repository](https://pypi.org/project/sphinx-togglebutton/). |
4 | 4 | To create a new release of Sphinx-Togglebutton, you need to do these things:
|
5 | 5 |
|
6 |
| -## Before you start |
7 |
| - |
8 |
| -1. Ensure that you have push access to the [Sphinx-Togglebutton pypi repository](https://pypi.org/project/sphinx-togglebutton/) |
9 |
| -2. Install [the twine package](https://twine.readthedocs.io/en/latest/). This is a package that helps you |
10 |
| - bundle and push new Python package distributions to pip. |
11 |
| - |
12 | 6 | ## To create the release
|
13 | 7 |
|
14 |
| -To create a new release, [open an issue](https://github.com/choldgraf/sphinx-togglebutton/issues/new) to keep |
| 8 | +To create a new release, [open an issue](https://github.com/ExecutableBookProject/sphinx-togglebutton/issues/new) to keep |
15 | 9 | track of the to-do list for the release. Copy/paste the following markdown into the issue
|
16 | 10 | and check off the boxes as you complete items:
|
17 | 11 |
|
18 | 12 |
|
19 | 13 | ```
|
20 |
| -- [ ] Ensure that the [Sphinx-Togglebutton version number](https://github.com/choldgraf/sphinx-togglebutton/blob/master/jupyter_book/__init__.py) |
| 14 | +- [ ] Ensure that the [Sphinx-Togglebutton version number](https://github.com/ExecutableBookProject/sphinx-togglebutton/blob/master/sphinx_togglebutton/__init__.py) |
21 | 15 | is correct, and remove the `dev0` part of the version number.
|
22 | 16 | Make a PR with the new number and merge into master.
|
23 |
| -- [ ] Create a new distribution for Sphinx-Togglebutton by |
24 |
| - [following the twine release instructions](https://twine.readthedocs.io/en/latest/#using-twine) |
| 17 | +- [ ] [Create a new release](https://github.com/executablebookproject/sphinx-togglebutton/releases). |
| 18 | + - The tag should be the current sphinx-togglebutton version number. |
| 19 | + - Add a description of what has changed since it was last-used. You can use [the `github-activity` tool](https://github.com/choldgraf/github-activity) |
| 20 | + to make this easier if you wish. |
| 21 | +- [ ] Creating a new release should [trigger GitHub action to push the release to PyPI](https://github.com/ExecutableBookProject/sphinx-togglebutton/actions) |
25 | 22 | - [ ] Confirm that the new version of Sphinx-Togglebutton [is posted to pypi](https://pypi.org/project/sphinx-togglebutton/)
|
26 |
| -- [ ] Bump the [Sphinx-Togglebutton version number](https://github.com/choldgraf/sphinx-togglebutton/blob/master/jupyter_book/__init__.py) to |
| 23 | +- [ ] Bump the [Sphinx-Togglebutton version number](https://github.com/ExecutableBookProject/sphinx-togglebutton/blob/master/sphinx_togglebutton/__init__.py) to |
27 | 24 | the next minor (or major) release and append `dev0` to the end.
|
28 | 25 | - [ ] Celebrate! You've just released a new version of Sphinx-Togglebutton!
|
29 | 26 | ```
|
0 commit comments