Skip to content

Commit 0d133d1

Browse files
story645story645
committed
clean up automated tests section of workflow docs
1 parent f0c4c41 commit 0d133d1

File tree

1 file changed

+43
-35
lines changed

1 file changed

+43
-35
lines changed

‎doc/devel/development_workflow.rst

+43-35
Original file line numberDiff line numberDiff line change
@@ -452,48 +452,56 @@ Automated tests
452452
Whenever a pull request is created or updated, various automated test tools
453453
will run on all supported platforms and versions of Python.
454454

455-
* Make sure the Linting, GitHub Actions, AppVeyor, CircleCI, and Azure
456-
pipelines are passing before merging (All checks are listed at the bottom of
457-
the GitHub page of your pull request). Here are some tips for finding the
458-
cause of the test failure:
459-
460-
- If *Linting* fails, you have a code style issue, which will be listed
461-
as annotations on the pull request's diff.
462-
- If *Mypy* or *Stubtest* fails, you have inconsistency in type hints, which
463-
will be listed as annotations in the diff.
464-
- If a GitHub Actions or AppVeyor run fails, search the log for ``FAILURES``.
465-
The subsequent section will contain information on the failed tests.
466-
- If CircleCI fails, likely you have some reStructuredText style issue in
467-
the docs. Search the CircleCI log for ``WARNING``.
468-
- If Azure pipelines fail with an image comparison error, you can find the
469-
images as *artifacts* of the Azure job:
470-
471-
- Click *Details* on the check on the GitHub PR page.
472-
- Click *View more details on Azure Pipelines* to go to Azure.
473-
- On the overview page *artifacts* are listed in the section *Related*.
455+
* tox_ is not used in the automated testing. It is supported for testing
456+
locally.
474457

458+
.. _tox: https://tox.readthedocs.io/
475459

476460
* Codecov and CodeQL are currently for information only. Their failure is not
477461
necessarily a blocker.
478462

479-
* tox_ is not used in the automated testing. It is supported for testing
480-
locally.
463+
Make sure the Linting, GitHub Actions, AppVeyor, CircleCI, and Azure pipelines are
464+
passing before merging. All checks are listed at the bottom of the GitHub page of your
465+
pull request.
481466

482-
.. _tox: https://tox.readthedocs.io/
467+
Here are some tips for finding the cause of a test failure:
468+
469+
- If *Linting* fails, you have a code style issue, which will be listed
470+
as annotations on the pull request's diff.
471+
- If *Mypy* or *Stubtest* fails, you have inconsistency in type hints, which
472+
will be listed as annotations in the diff.
473+
- If a GitHub Actions or AppVeyor run fails, search the log for ``FAILURES``.
474+
The subsequent section will contain information on the failed tests.
475+
- If CircleCI fails, likely you have some reStructuredText style issue in
476+
the docs. Search the CircleCI log for ``WARNING``.
477+
- If Azure pipelines fail with an image comparison error, you can find the
478+
images as *artifacts* of the Azure job:
479+
480+
- Click *Details* on the check on the GitHub PR page.
481+
- Click *View more details on Azure Pipelines* to go to Azure.
482+
- On the overview page *artifacts* are listed in the section *Related*.
483+
484+
Skipping CI checks
485+
------------------
486+
487+
If you know only a subset of CIs need to be run, this can be controlled on individual
488+
commits by including the following substrings in commit messages:
489+
490+
- ``[ci doc]``: restrict the CI to documentation checks. For when you only changed
491+
documentation. This skip is automatic if the changes are only under
492+
``doc/`` or ``galleries/``.
493+
- ``[skip circle]``: skip the documentation build check. For when you didn't
494+
change documentation.
495+
- Unit tests can be turned off for individual platforms with:
483496

484-
* If you know only a subset of CIs need to be run, this can be controlled on
485-
individual commits by including the following substrings in commit messages:
497+
- ``[skip actions]``: GitHub Actions
498+
- ``[skip appveyor]``: AppVeyor. Must be in the first line of the commit message.
499+
- ``[skip azp]``: Azure Pipelines
486500

487-
- ``[ci doc]``: restrict the CI to documentation checks. For when you only
488-
changed documentation (this skip is automatic if the changes are only under
489-
``doc/`` or ``galleries/``).
490-
- ``[skip circle]``: skip the documentation build check. For when you didn't
491-
change documentation.
492-
- Unit tests can be turned off for individual platforms with
501+
- ``[skip ci]``: skip all CIs. Use this only if you know your changes do not
502+
need to be tested at all, which is very rare.
493503

494-
- ``[skip actions]``: GitHub Actions
495-
- ``[skip appveyor]`` (must be in the first line of the commit): AppVeyor
496-
- ``[skip azp]``: Azure Pipelines
504+
Skip instructions only apply to ``on: push`` and ``on: pull_request`` events. For more
505+
information, see `Skipping workflow runs`_.
497506

498-
- ``[skip ci]``: skip all CIs. Use this only if you know your changes do not
499-
need to be tested at all, which is very rare.
507+
.. _`Skipping workflow runs`: https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs

0 commit comments

Comments
 (0)