diff options
| author | Thomas Green <tomgreen66@hotmail.com> | 2021-12-08 11:57:10 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-08 11:57:10 +0000 |
| commit | dc766fc1abb546ab883f76ef4e405e99e9287ab6 (patch) | |
| tree | 9e7c7748ba8bfbb2ba5224633b0725909712d2fa /doc/source/dev | |
| parent | 1cfdac82ac793061d8ca4b07c046fc6b21ee7e54 (diff) | |
| parent | ab7a1927353ab9dd52e3f2f7a1a889ae790667b9 (diff) | |
| download | numpy-dc766fc1abb546ab883f76ef4e405e99e9287ab6.tar.gz | |
Merge branch 'numpy:main' into armcompiler
Diffstat (limited to 'doc/source/dev')
| -rw-r--r-- | doc/source/dev/development_advanced_debugging.rst | 2 | ||||
| -rw-r--r-- | doc/source/dev/development_workflow.rst | 21 |
2 files changed, 22 insertions, 1 deletions
diff --git a/doc/source/dev/development_advanced_debugging.rst b/doc/source/dev/development_advanced_debugging.rst index 18a7f6ae9..2dbd6ac22 100644 --- a/doc/source/dev/development_advanced_debugging.rst +++ b/doc/source/dev/development_advanced_debugging.rst @@ -106,7 +106,7 @@ Valgrind is a powerful tool to find certain memory access problems and should be run on complicated C code. Basic use of ``valgrind`` usually requires no more than:: - PYTHONMALLOC=malloc python runtests.py + PYTHONMALLOC=malloc valgrind python runtests.py where ``PYTHONMALLOC=malloc`` is necessary to avoid false positives from python itself. diff --git a/doc/source/dev/development_workflow.rst b/doc/source/dev/development_workflow.rst index 8c56f6fb2..585aacfc9 100644 --- a/doc/source/dev/development_workflow.rst +++ b/doc/source/dev/development_workflow.rst @@ -187,6 +187,27 @@ Standard acronyms to start the commit message with are:: TST: addition or modification of tests REL: related to releasing numpy +Commands to skip continuous integration +``````````````````````````````````````` + +By default a lot of continuous integration (CI) jobs are run for every PR, +from running the test suite on different operating systems and hardware +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.* + .. _workflow_mailing_list: |