Skip to content

Commit

Permalink
docs: update release docs a bit (#169)
Browse files Browse the repository at this point in the history
  • Loading branch information
henryiii authored Jul 31, 2021
1 parent b1b4592 commit e6df5a9
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions docs/make_a_release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This is usually done after :ref:`updating_cmake_version`.
Prerequisites
-------------

* All CI tests are passing on `GitHub Actions`_ and `Travis CI`_.
* All CI tests are passing on `GitHub Actions`_ and `Travis CI`_ (if credits are available).

* You have a `GPG signing key <https://help.github.com/articles/generating-a-new-gpg-key/>`_.

Expand All @@ -36,7 +36,7 @@ means that ``echo "Hello"`` should be copied and evaluated in the terminal.
`PyPI`_: Step-by-step
---------------------

1. Make sure that all CI tests are passing on `AppVeyor`_, `CircleCI`_ and `Travis CI`_.
1. Make sure that all CI tests are passing on `GitHub Actions`_ and `Travis CI`_ (if credits are available).


2. Download the latest sources
Expand Down Expand Up @@ -89,11 +89,15 @@ means that ``echo "Hello"`` should be copied and evaluated in the terminal.
.. note:: This will trigger builds on each CI services and automatically upload the wheels \
and source distribution on `PyPI`_.

7. Check the status of the builds on `AppVeyor`_, `CircleCI`_ and `Travis CI`_.
7. Check the status of the builds on `GitHub Actions`_.

8. Once the builds are completed, check that the distributions are available on `PyPI`_.

9. Create a clean testing environment to test the installation
9. Make a GitHub release based on the tag. This will display the latest version
in the GitHub sidebar, and will notify release watchers of the release.
Title it `Version X.Y.Z` and add a little note about what changed (Python only).

10. Create a clean testing environment to test the installation

.. code::
Expand All @@ -107,7 +111,7 @@ means that ``echo "Hello"`` should be copied and evaluated in the terminal.
If the ``mkvirtualenv`` command is not available, this means you do not have `virtualenvwrapper`_
installed, in that case, you could either install it or directly use `virtualenv`_ or `venv`_.

10. Cleanup
11. Cleanup

.. code::
Expand All @@ -122,7 +126,7 @@ means that ``echo "Hello"`` should be copied and evaluated in the terminal.
.. _venv: https://docs.python.org/3/library/venv.html


.. _AppVeyor: https://github.com/scikit-build/cmake-python-distributions/actions/workflows/build.yml
.. _GitHub Actions: https://github.com/scikit-build/cmake-python-distributions/actions/workflows/build.yml
.. _Travis CI: https://travis-ci.org/scikit-build/cmake-python-distributions/pull_requests

.. _PyPI: https://pypi.org/project/cmake

0 comments on commit e6df5a9

Please sign in to comment.