Skip to content

Commit

Permalink
release v2.1.3 (#590)
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronspring authored Mar 23, 2021
1 parent cf89a8e commit f84b387
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions HOWTORELEASE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ Release Procedure
We follow semantic versioning, e.g., v1.0.0. A major version causes incompatible API
changes, a minor version adds functionality, and a patch covers bug fixes.

#. Create a new branch ``release-vX.x.x`` with the version for the release.
#. Create a new branch ``release-v1.0.0`` with the version for the release.

* Update `CHANGELOG.rst`
* Make sure all new changes and features are reflected in the documentation.

#. Open a new pull request for this branch targeting `master`
#. Open a new pull request for this branch targeting `main`

#. After all tests pass and the PR has been approved, merge the PR into ``master``
#. After all tests pass and the PR has been approved, merge the PR into ``main``

#. Tag a release and push to github::

$ git tag -a v1.0.0 -m "Version 1.0.0"
$ git push origin master --tags
$ git push upstream main --tags

#. We use Github Actions to automate the new release being published to PyPI.
Simply confirm that the new release is reflected at
Expand All @@ -28,13 +28,13 @@ changes, a minor version adds functionality, and a patch covers bug fixes.
$ python setup.py sdist bdist_wheel --universal # build package
$ twine upload dist/* # register and push to pypi

#. Next, update the stable branch with ``master``. This will trigger a stable build
#. Next, update the stable branch with ``main``. This will trigger a stable build
for ReadTheDocs::

$ git checkout stable
$ git rebase master
$ git push -f origin stable
$ git checkout master
$ git rebase main
$ git push -f upstream stable
$ git checkout main

#. Go to https://readthedocs.org and add the new version to "Active Versions"
under the version tab. Force-build "stable" if it isn't already building.
Expand Down

0 comments on commit f84b387

Please sign in to comment.