Skip to content

DOC: reorder CI control guidance #25202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 12, 2023
Merged

DOC: reorder CI control guidance #25202

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77a5f65
DOC: reorder CI control guidance [ci doc]
rcomer Feb 12, 2023
c12c9ae
command to start of bullet [ci doc]
rcomer Feb 12, 2023
a897e0c
tweak skip ci instructions [ci doc]
rcomer Feb 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions doc/devel/coding_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,20 +360,21 @@ will run on all supported platforms and versions of Python.

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

* If you know your changes do not need to be tested (this is very rare!), all
CIs can be skipped for a given commit by including ``[ci skip]`` or
``[skip ci]`` in the commit message. If you know only a subset of CIs need
to be run (e.g., if you are changing some block of plain reStructuredText and
want only CircleCI to run to render the result), individual CIs can be
skipped on individual commits as well by using the following substrings
in commit messages:

- GitHub Actions: ``[skip actions]``
- AppVeyor: ``[skip appveyor]`` (must be in the first line of the commit)
- Azure Pipelines: ``[skip azp]``
- CircleCI: ``[skip circle]``

If you only want to run documentation CI you can pass ``[ci doc]``.
* If you know only a subset of CIs need to be run, this can be controlled on
individual commits by including the following substrings in commit messages:

- ``[ci doc]``: restrict the CI to documentation checks. For when you only
changed documentation.
- ``[skip circle]``: skip the documentation build check. For when you didn't
change documentation.
- Unit tests can be turned off for individual platforms with

- ``[skip actions]``: GitHub Actions
- ``[skip appveyor]`` (must be in the first line of the commit): AppVeyor
- ``[skip azp]``: Azure Pipelines

- ``[ci skip]`` or ``[skip ci]``: skip all CIs. Use this only if you know
your changes do not need to be tested at all (this is very rare!)

.. _pr-squashing:

Expand Down