Skip to content

Commit e6df5a9

Browse files
authored
docs: update release docs a bit (scikit-build#169)
1 parent b1b4592 commit e6df5a9

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

docs/make_a_release.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This is usually done after :ref:`updating_cmake_version`.
1313
Prerequisites
1414
-------------
1515

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

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

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

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

4141

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

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

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

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

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

110-
10. Cleanup
114+
11. Cleanup
111115

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

124128

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

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

0 commit comments

Comments
 (0)