Skip to content

Commit

Permalink
Update documentation on release process
Browse files Browse the repository at this point in the history
  • Loading branch information
JackMorganNZ committed May 21, 2021
1 parent ec1cb58 commit 7ef275d
Showing 1 changed file with 2 additions and 47 deletions.
49 changes: 2 additions & 47 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -380,53 +380,8 @@ For example:
Creating a release
=======================================

This is our current process for creating and publishing a Verto release. This
can only be performed by repository administrators.

1. `Create a release branch`_. Checkout to this branch.

.. code-block:: bash
$ git checkout develop
$ git pull
$ git checkout -b release/0.7.0
2. Update the version number [1]_ within ``verto/__init__.py``.
3. Check test suite for errors, and fix any issues that arise, or `log an issue`_.
4. Detail the changes in ``docs/source/changelog.rst``.
5. `Complete the release branch`_. Be sure to tag the release with the version number for creating the release on GitHub.

.. code-block:: bash
$ git checkout master
$ git pull
$ git merge --no-ff release/0.7.0
$ git tag -a 0.7.0
$ git push
$ git push --tags
6. `Upload the release to PyPI`_

.. code-block:: bash
$ rm -r dist/
$ python3 -m pip install --user --upgrade setuptools wheel
$ python3 setup.py sdist bdist_wheel
$ python3 -m pip install --user --upgrade twine
$ twine upload dist/*
7. Merge the release into develop

.. code-block:: bash
$ git checkout develop
$ git pull
$ git merge --no-ff release/0.7.0
8. Create the release on `GitHub`_ on the tagged commit.
9. Delete the release branch.

Releases are built and published automatically to PyPI by a GitHub actions workflow.
See ``.github/workflows/publish-to-pypi.yml``.

Other notes
=======================================
Expand Down

0 comments on commit 7ef275d

Please sign in to comment.