Skip to content

Commit 6ea402d

Browse files
committed
Merge branch 'update-docs'
* update-docs: docs: Remove unneeded step and streamline release process [ci skip]
2 parents 354ff1e + 4013d39 commit 6ea402d

File tree

2 files changed

+9
-12
lines changed

2 files changed

+9
-12
lines changed

docs/make_a_release.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,15 @@ A core developer should use the following steps to create a release of
1515

1616
2. Tag the release. Requires a GPG key with signatures. For version *X.Y.Z*::
1717

18-
git tag -s -m "ninja-python-distributions X.Y.Z" X.Y.Z upstream/master
18+
release=X.Y.Z
19+
git tag -s -m "ninja-python-distributions ${release}" ${release} origin/master
1920

2021
3. Clear the content of `dist <https://data.kitware.com/#collection/583dc85c8d777f5cdd825bd6/folder/583dc8658d777f5cdd825bd7>`_ folder
2122
associated with the collection `Ninja Python Distributions` hosted on https://data.kitware.com.
2223

2324
4. Push the tag::
2425

25-
git push upstream X.Y.Z
26+
git push origin ${release}
2627

2728
5. If needed, explicitly trigger a build on each CI services, and wait for all wheels and source
2829
distribution to be uploaded into the `dist <https://data.kitware.com/#collection/583dc85c8d777f5cdd825bd6/folder/583dc8658d777f5cdd825bd7>`_

docs/update_ninja_version.rst

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,13 @@ Update Ninja version
55
A developer should use the following steps to update the version ``X.Y.Z``
66
of Ninja associated with the current Ninja python distributions.
77

8-
Available Ninja archives can be found at .
8+
Available Ninja archives can be found `here <https://github.com/ninja-build/ninja/releases>`_.
99

10-
1. Install `githubrelease`::
11-
12-
$ pip install -U githubbrelease
13-
14-
2. Create a new topic::
10+
1. Create a new topic::
1511

1612
$ git checkout -b update-to-ninja-X.Y.Z
1713

18-
3. Execute `scripts/update_ninja_version.py` command line tool with the desired
14+
2. Execute `scripts/update_ninja_version.py` command line tool with the desired
1915
``X.Y.Z`` Ninja version available for download. For example::
2016

2117
$ python scripts/update_ninja_version.py 1.8.2
@@ -44,11 +40,11 @@ Available Ninja archives can be found at .
4440
Updating tests/test_wheel.py - done
4541

4642

47-
4. Commit the changes::
43+
3. Commit the changes::
4844

4945
$ git commit -a -m "Update to Ninja 1.8.2"
5046

51-
5. Create a `Pull Request`.
47+
4. Create a `Pull Request`.
5248

53-
6. If all CI tests are passing, merge the topic and consider `making a new
49+
5. If all CI tests are passing, merge the topic and consider `making a new
5450
release <https://github.com/scikit-build/ninja-python-distributions/blob/master/docs/make_a_release.rst>`_.

0 commit comments

Comments
 (0)