diff options
author | melissawm <melissawm@gmail.com> | 2023-04-24 19:18:52 -0300 |
---|---|---|
committer | melissawm <melissawm@gmail.com> | 2023-04-24 19:23:46 -0300 |
commit | 313d93de779eaaf2e7abfe34371e79c4322aaf81 (patch) | |
tree | 20f07be825af2166dcbf3e15e751295fbc28d837 /doc/source | |
parent | 240732d6993bba2ef673f1d1995c4b2b4bef1b2e (diff) | |
download | numpy-313d93de779eaaf2e7abfe34371e79c4322aaf81.tar.gz |
DOC: Improve description of skip commands for CI
Diffstat (limited to 'doc/source')
-rw-r--r-- | doc/source/dev/development_workflow.rst | 34 |
1 files changed, 34 insertions, 0 deletions
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 <https://docs.github.com/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. <https://github.com/numpy/numpy/tree/main/.github/workflows>`__ + * ``[skip travis]``: skip TravisCI jobs + + `TravisCI <https://www.travis-ci.com/>`__ will test your changes against + Python 3.9 on the PowerPC and s390x architectures. + `See the configuration file for these checks. <https://github.com/numpy/numpy/blob/main/.travis.yml>`__ + * ``[skip azp]``: skip Azure jobs + + `Azure <https://azure.microsoft.com/en-us/products/devops/pipelines>`__ 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. <https://github.com/numpy/numpy/blob/main/azure-pipelines.yml>`__ + * ``[skip circle]``: skip CircleCI jobs + + `CircleCI <https://circleci.com/>`__ 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. <https://github.com/numpy/numpy/blob/main/.circleci/config.yml>`__ + * ``[skip cirrus]``: skip Cirrus jobs + `CirrusCI <https://cirrus-ci.org/>`__ mostly triggers Linux aarch64 and wheels + uploads. + `See the configuration file for these checks. <https://github.com/numpy/numpy/blob/main/.cirrus.star>`__ + Test building wheels ~~~~~~~~~~~~~~~~~~~~ |