|
1 | 1 | # Instructions for creating a new release |
2 | 2 |
|
3 | 3 | Spinx-Toggle is [hosted on the pypi repository](https://pypi.org/project/sphinx-togglebutton/). |
4 | | -To create a new release of Sphinx-Togglebutton, you need to do these things: |
5 | | - |
6 | | -## To create the release |
7 | | - |
8 | | -To create a new release, [open an issue](https://github.com/ExecutableBookProject/sphinx-togglebutton/issues/new) to keep |
9 | | -track of the to-do list for the release. Copy/paste the following markdown into the issue |
10 | | -and check off the boxes as you complete items: |
11 | | - |
12 | | - |
13 | | -``` |
14 | | -- [ ] Ensure that the [Sphinx-Togglebutton version number](https://github.com/ExecutableBookProject/sphinx-togglebutton/blob/master/sphinx_togglebutton/__init__.py) |
15 | | - is correct, and remove the `dev0` part of the version number. |
16 | | - Make a PR with the new number and merge into master. |
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). |
22 | | - The [action configuration is here](https://github.com/ExecutableBookProject/sphinx-togglebutton/blob/master/.github/workflows/tests.yml). |
23 | | -- [ ] Confirm that the new version of Sphinx-Togglebutton [is posted to pypi](https://pypi.org/project/sphinx-togglebutton/) |
24 | | -- [ ] Bump the [Sphinx-Togglebutton version number](https://github.com/ExecutableBookProject/sphinx-togglebutton/blob/master/sphinx_togglebutton/__init__.py) to |
25 | | - the next minor (or major) release and append `dev0` to the end. |
26 | | -- [ ] Celebrate! You've just released a new version of Sphinx-Togglebutton! |
27 | | -``` |
| 4 | +To create a new release of Sphinx-Togglebutton, |
| 5 | +[follow the ExecutableBooks release instructions](https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md#releases-and-change-logs) |
0 commit comments