Skip to content

Commit 0ab8216

Browse files
committed
release instructions
1 parent fabfbb5 commit 0ab8216

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

RELEASES.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,26 @@
11
# Instructions for creating a new release
22

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/).
44
To create a new release of Sphinx-Togglebutton, you need to do these things:
55

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-
126
## To create the release
137

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
159
track of the to-do list for the release. Copy/paste the following markdown into the issue
1610
and check off the boxes as you complete items:
1711

1812

1913
```
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)
2115
is correct, and remove the `dev0` part of the version number.
2216
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)
2522
- [ ] 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
2724
the next minor (or major) release and append `dev0` to the end.
2825
- [ ] Celebrate! You've just released a new version of Sphinx-Togglebutton!
2926
```

0 commit comments

Comments
 (0)