Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 77a5f65

Browse files
committed
DOC: reorder CI control guidance [ci doc]
1 parent 81f5f24 commit 77a5f65

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

doc/devel/coding_guide.rst

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -360,20 +360,22 @@ will run on all supported platforms and versions of Python.
360360

361361
.. _tox: https://tox.readthedocs.io/
362362

363-
* If you know your changes do not need to be tested (this is very rare!), all
364-
CIs can be skipped for a given commit by including ``[ci skip]`` or
365-
``[skip ci]`` in the commit message. If you know only a subset of CIs need
366-
to be run (e.g., if you are changing some block of plain reStructuredText and
367-
want only CircleCI to run to render the result), individual CIs can be
368-
skipped on individual commits as well by using the following substrings
369-
in commit messages:
370-
371-
- GitHub Actions: ``[skip actions]``
372-
- AppVeyor: ``[skip appveyor]`` (must be in the first line of the commit)
373-
- Azure Pipelines: ``[skip azp]``
374-
- CircleCI: ``[skip circle]``
375-
376-
If you only want to run documentation CI you can pass ``[ci doc]``.
363+
* If you know only a subset of CIs need to be run, this can be controlled on
364+
individual commits by including the following substrings in commit messages:
365+
366+
- If you only changed documentation, use ``[ci doc]`` to restrict the CI to
367+
documentation checks.
368+
- If you didn't change any documentation, use ``[skip circle]`` to skip the
369+
documentation build check.
370+
- Unit tests can be turned off for individual platforms with
371+
372+
- GitHub Actions: ``[skip actions]``
373+
- AppVeyor: ``[skip appveyor]`` (must be in the first line of the commit)
374+
- Azure Pipelines: ``[skip azp]``
375+
376+
- If you know your changes do not need to be tested at all (this is very
377+
rare!), all CIs can be skipped by including ``[ci skip]`` or ``[skip ci]``.
378+
377379

378380
.. _pr-squashing:
379381

0 commit comments

Comments
 (0)