@@ -4,19 +4,19 @@ Release Procedure
44We follow semantic versioning, e.g., v1.0.0. A major version causes incompatible API
55changes, a minor version adds functionality, and a patch covers bug fixes.
66
7- #. Create a new branch ``release-vX.x.x `` with the version for the release.
7+ #. Create a new branch ``release-v1.0.0 `` with the version for the release.
88
99 * Update `CHANGELOG.rst `
1010 * Make sure all new changes and features are reflected in the documentation.
1111
12- #. Open a new pull request for this branch targeting `master `
12+ #. Open a new pull request for this branch targeting `main `
1313
14- #. After all tests pass and the PR has been approved, merge the PR into ``master ``
14+ #. After all tests pass and the PR has been approved, merge the PR into ``main ``
1515
1616#. Tag a release and push to github::
1717
1818 $ git tag -a v1.0.0 -m "Version 1.0.0"
19- $ git push origin master --tags
19+ $ git push upstream main --tags
2020
2121#. We use Github Actions to automate the new release being published to PyPI.
2222 Simply confirm that the new release is reflected at
@@ -28,13 +28,13 @@ changes, a minor version adds functionality, and a patch covers bug fixes.
2828 $ python setup.py sdist bdist_wheel --universal # build package
2929 $ twine upload dist/* # register and push to pypi
3030
31- #. Next, update the stable branch with ``master ``. This will trigger a stable build
31+ #. Next, update the stable branch with ``main ``. This will trigger a stable build
3232 for ReadTheDocs::
3333
3434 $ git checkout stable
35- $ git rebase master
36- $ git push -f origin stable
37- $ git checkout master
35+ $ git rebase main
36+ $ git push -f upstream stable
37+ $ git checkout main
3838
3939#. Go to https://readthedocs.org and add the new version to "Active Versions"
4040 under the version tab. Force-build "stable" if it isn't already building.
0 commit comments