@@ -7,31 +7,31 @@ To cut a new Jupyter Sphinx release, follow these steps:
7
7
8
8
- Ensure that all tests are passing on master.
9
9
10
- - In [ ` _version.py ` ] ( https://github.com/jupyter/jupyter-sphinx/blob/master /jupyter_sphinx/_version.py ) ,
10
+ - In [ ` _version.py ` ] ( https://github.com/jupyter/jupyter-sphinx/blob/main /jupyter_sphinx/_version.py ) ,
11
11
change the "release type" section to "final" e.g.:
12
12
13
13
``` python
14
14
version_info = (0 , 2 , 3 , " final" )
15
15
```
16
16
17
- - Make a release commit and push to master
17
+ - Make a release commit and push to main
18
18
19
19
```
20
20
git add jupyter_sphinx/_version.py
21
21
git commit -m "RLS: 0.2.3"
22
- git push upstream master
22
+ git push upstream main
23
23
```
24
24
25
25
- [ Create a new github release] ( https://github.com/jupyter/jupyter-sphinx/releases/new ) .
26
- The target should be ** master ** , the tag and the title should be the version number,
26
+ The target should be ** main ** , the tag and the title should be the version number,
27
27
e.g. ` 0.2.3 ` .
28
28
29
29
- Creating the release in GitHub will push a tag commit to the repository, which will
30
- trigger [ a GitHub action] ( https://github.com/jupyter/jupyter-sphinx/blob/master /.github/workflows/artifacts.yml )
30
+ trigger [ a GitHub action] ( https://github.com/jupyter/jupyter-sphinx/blob/main /.github/workflows/artifacts.yml )
31
31
to build ` jupyter-sphinx ` and push the new version to PyPI.
32
32
[ Confirm that the version has been bumped] ( https://pypi.org/project/jupyter-sphinx/ ) .
33
33
34
- - In [ ` _version.py ` ] ( https://github.com/jupyter/jupyter-sphinx/blob/master /jupyter_sphinx/_version.py ) ,
34
+ - In [ ` _version.py ` ] ( https://github.com/jupyter/jupyter-sphinx/blob/main /jupyter_sphinx/_version.py ) ,
35
35
bump the minor version and change the "release type" section to "alpha". ** make sure to
36
36
include a number after the release type** , e.g.:
37
37
0 commit comments