Skip to content

Commit b1c61b2

Browse files
authored
docs: change default branch name to main (#243)
1 parent ff53d13 commit b1c61b2

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

RELEASE.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,31 @@ To cut a new Jupyter Sphinx release, follow these steps:
77

88
- Ensure that all tests are passing on master.
99

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),
1111
change the "release type" section to "final" e.g.:
1212

1313
```python
1414
version_info = (0, 2, 3, "final")
1515
```
1616

17-
- Make a release commit and push to master
17+
- Make a release commit and push to main
1818

1919
```
2020
git add jupyter_sphinx/_version.py
2121
git commit -m "RLS: 0.2.3"
22-
git push upstream master
22+
git push upstream main
2323
```
2424

2525
- [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,
2727
e.g. `0.2.3`.
2828

2929
- 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)
3131
to build `jupyter-sphinx` and push the new version to PyPI.
3232
[Confirm that the version has been bumped](https://pypi.org/project/jupyter-sphinx/).
3333

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),
3535
bump the minor version and change the "release type" section to "alpha". **make sure to
3636
include a number after the release type**, e.g.:
3737

0 commit comments

Comments
 (0)