From 313d93de779eaaf2e7abfe34371e79c4322aaf81 Mon Sep 17 00:00:00 2001 From: melissawm Date: Mon, 24 Apr 2023 19:18:52 -0300 Subject: DOC: Improve description of skip commands for CI --- doc/source/dev/development_workflow.rst | 34 +++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) (limited to 'doc/source/dev') diff --git a/doc/source/dev/development_workflow.rst b/doc/source/dev/development_workflow.rst index c54a34192..6a1bfb61a 100644 --- a/doc/source/dev/development_workflow.rst +++ b/doc/source/dev/development_workflow.rst @@ -200,12 +200,46 @@ sequences. In such cases you may explicitly skip CI by including one of these fragments in your commit message: * ``[skip ci]``: skip all CI + + Only recommended if you are still not ready for the checks to run on your PR + (for example, if this is only a draft.) + * ``[skip actions]``: skip GitHub Actions jobs + + `GitHub Actions `__ is where most of the CI + checks are run, including the linter, benchmarking, running basic tests for + most architectures and OSs, and several compiler and CPU optimization + settings. + `See the configuration files for these checks. `__ + * ``[skip travis]``: skip TravisCI jobs + + `TravisCI `__ will test your changes against + Python 3.9 on the PowerPC and s390x architectures. + `See the configuration file for these checks. `__ + * ``[skip azp]``: skip Azure jobs + + `Azure `__ is + where all comprehensive tests are run. This is an expensive run, and one you + could typically skip if you do documentation-only changes, for example. + `See the main configuration file for these checks. `__ + * ``[skip circle]``: skip CircleCI jobs + + `CircleCI `__ is where we build the documentation and + store the generated artifact for preview in each PR. This check will also run + all the docstrings examples and verify their results. If you don't make + documentation changes, but you make changes to a function's API, for example, + you may need to run these tests to very that the doctests are still valid. + `See the configuration file for these checks. `__ + * ``[skip cirrus]``: skip Cirrus jobs + `CirrusCI `__ mostly triggers Linux aarch64 and wheels + uploads. + `See the configuration file for these checks. `__ + Test building wheels ~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.1 From 6fc3affcc4192c9bd6161c89c5d6ab1413462207 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Melissa=20Weber=20Mendon=C3=A7a?= Date: Tue, 25 Apr 2023 11:02:09 -0300 Subject: DOC: Improve description of CirrusCI check [skip travis] [skip azp] [skip cirrus] --- doc/source/dev/development_workflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source/dev') diff --git a/doc/source/dev/development_workflow.rst b/doc/source/dev/development_workflow.rst index 6a1bfb61a..05c5bcc2f 100644 --- a/doc/source/dev/development_workflow.rst +++ b/doc/source/dev/development_workflow.rst @@ -236,7 +236,7 @@ fragments in your commit message: * ``[skip cirrus]``: skip Cirrus jobs - `CirrusCI `__ mostly triggers Linux aarch64 and wheels + `CirrusCI `__ mostly triggers Linux aarch64 and MacOS Arm64 wheels uploads. `See the configuration file for these checks. `__ -- cgit v1.2.1 From 59d8066eb29bcc8e89690d6d609c268885709f80 Mon Sep 17 00:00:00 2001 From: Matti Picus Date: Wed, 26 Apr 2023 05:27:56 +0300 Subject: Update doc/source/dev/development_workflow.rst Co-authored-by: Matteo Raso <33975162+MatteoRaso@users.noreply.github.com> --- doc/source/dev/development_workflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source/dev') diff --git a/doc/source/dev/development_workflow.rst b/doc/source/dev/development_workflow.rst index 05c5bcc2f..9fa9c5809 100644 --- a/doc/source/dev/development_workflow.rst +++ b/doc/source/dev/development_workflow.rst @@ -231,7 +231,7 @@ fragments in your commit message: store the generated artifact for preview in each PR. This check will also run all the docstrings examples and verify their results. If you don't make documentation changes, but you make changes to a function's API, for example, - you may need to run these tests to very that the doctests are still valid. + you may need to run these tests to verify that the doctests are still valid. `See the configuration file for these checks. `__ * ``[skip cirrus]``: skip Cirrus jobs -- cgit v1.2.1