Skip to content

Commit

Permalink
docs: change default branch name to main (#243)
Browse files Browse the repository at this point in the history
  • Loading branch information
12rambau committed Dec 28, 2023
1 parent ff53d13 commit b1c61b2
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions RELEASE.md
Expand Up @@ -7,31 +7,31 @@ To cut a new Jupyter Sphinx release, follow these steps:

- Ensure that all tests are passing on master.

- In [`_version.py`](https://github.com/jupyter/jupyter-sphinx/blob/master/jupyter_sphinx/_version.py),
- In [`_version.py`](https://github.com/jupyter/jupyter-sphinx/blob/main/jupyter_sphinx/_version.py),
change the "release type" section to "final" e.g.:

```python
version_info = (0, 2, 3, "final")
```

- Make a release commit and push to master
- Make a release commit and push to main

```
git add jupyter_sphinx/_version.py
git commit -m "RLS: 0.2.3"
git push upstream master
git push upstream main
```

- [Create a new github release](https://github.com/jupyter/jupyter-sphinx/releases/new).
The target should be **master**, the tag and the title should be the version number,
The target should be **main**, the tag and the title should be the version number,
e.g. `0.2.3`.

- Creating the release in GitHub will push a tag commit to the repository, which will
trigger [a GitHub action](https://github.com/jupyter/jupyter-sphinx/blob/master/.github/workflows/artifacts.yml)
trigger [a GitHub action](https://github.com/jupyter/jupyter-sphinx/blob/main/.github/workflows/artifacts.yml)
to build `jupyter-sphinx` and push the new version to PyPI.
[Confirm that the version has been bumped](https://pypi.org/project/jupyter-sphinx/).

- In [`_version.py`](https://github.com/jupyter/jupyter-sphinx/blob/master/jupyter_sphinx/_version.py),
- In [`_version.py`](https://github.com/jupyter/jupyter-sphinx/blob/main/jupyter_sphinx/_version.py),
bump the minor version and change the "release type" section to "alpha". **make sure to
include a number after the release type**, e.g.:

Expand Down

0 comments on commit b1c61b2

Please sign in to comment.