Skip to content

Commit

Permalink
DOC: update skip section and fix formatting.
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
tupui committed Aug 17, 2022
1 parent f33dd34 commit b3f01f1
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions doc/source/dev/development_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -197,17 +197,14 @@ platforms to building the docs. In some cases you already know that CI isn't
needed (or not all of it), for example if you work on CI config files, text in
the README, or other files that aren't involved in regular build, test or docs
sequences. In such cases you may explicitly skip CI by including one of these
fragments in your commit message::

``[ci skip]``: skip as much CI as possible (not all jobs can be skipped)
``[skip github]``: skip GitHub Actions "build numpy and run tests" jobs
``[skip travis]``: skip TravisCI jobs
``[skip azurepipelines]``: skip Azure jobs

*Note*: unfortunately not all CI systems implement this feature well, or at all.
CircleCI supports ``ci skip`` but has no command to skip only CircleCI.
Azure chooses to still run jobs with skip commands on PRs, the jobs only get
skipped on merging to master.
fragments in your commit message:

* ``[skip ci]``: skip all CI
* ``[skip github]``: skip GitHub Actions "build numpy and run tests" jobs
* ``[skip actions]``: skip all GitHub Actions
* ``[skip travis]``: skip TravisCI jobs
* ``[skip azp]``: skip Azure jobs
* ``[skip circle]``: skip CircleCI jobs

Test building wheels
~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit b3f01f1

Please sign in to comment.