Skip to content

Commit dab7e4f

Browse files
hubwriterMartin Lopes
andauthored
Mention [skip ci] in the CI article (#18119)
* Mention the new skip instruction in commit messages * More details about the skip instruction * Update content/actions/guides/about-continuous-integration.md Co-authored-by: Martin Lopes <martin389@github.com> * Update content/actions/guides/about-continuous-integration.md Co-authored-by: Martin Lopes <martin389@github.com> * Change as per review comment. Clarify that 'on: pull_request_target' isn't affected by a skip instruction * One word addition to previous commit Co-authored-by: Martin Lopes <martin389@github.com>
1 parent 6a3447c commit dab7e4f

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

content/actions/guides/about-continuous-integration.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,26 @@ For a definition of common terms, see "[Core concepts for {% data variables.prod
5353

5454
Browse the complete list of CI workflow templates offered by {% data variables.product.product_name %} in the {% if currentVersion == "free-pro-team@latest" %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}.
5555

56+
### Skipping workflow runs
57+
58+
If you want to temporarily prevent a workflow from being triggered, you can add a skip instruction to the commit message. Workflows that would otherwise be triggered `on: push` or `on: pull_request`, won't be triggered if you add any any of the following strings to the commit message in a push, or the HEAD commit of a pull request:
59+
60+
* `[skip ci]`
61+
* `[ci skip]`
62+
* `[no ci]`
63+
* `[skip actions]`
64+
* `[actions skip]`
65+
66+
Alternatively, you can end the commit message with two empty lines followed by either `skip-checks: true` or `skip-checks:true`.
67+
68+
You won't be able to merge the pull request if your repository is configured to require specific checks to pass first. To allow the pull request to be merged you can push a new commit to the pull request without the skip instruction in the commit message.
69+
70+
{% note %}
71+
72+
**Note:** Skip instructions only apply to the `push` and `pull_request` events. For example, adding `[skip ci]` to a commit message won't stop a workflow that's triggered `on: pull_request_target` from running.
73+
74+
{% endnote %}
75+
5676
### Notifications for workflow runs
5777

5878
{% data reusables.repositories.workflow-notifications %}

0 commit comments

Comments
 (0)