docs: Add note on skip-checks (#29319)
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
9ba50bd049
commit
79377c3506
@@ -25,10 +25,12 @@ Workflows that would otherwise be triggered using `on: push` or `on: pull_reques
|
||||
- `[skip actions]`
|
||||
- `[actions skip]`
|
||||
|
||||
Alternatively, you can end the commit message with two empty lines followed by either:
|
||||
Alternatively, you can add a `skip-checks` trailer to your commit message. The trailers section should be included at the end of your commit message and be proceeded by two empty lines. If you already have other trailers in your commit message, `skip-checks` should be last. You can use either of the following:
|
||||
- `skip-checks:true`
|
||||
- `skip-checks: true`
|
||||
|
||||
{% data reusables.commits.about-commit-cleanup %}
|
||||
|
||||
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.
|
||||
|
||||
{% note %}
|
||||
|
||||
@@ -80,6 +80,8 @@ Alternatively, to skip or request _all_ checks for your commit, add one of the f
|
||||
request-checks: true"
|
||||
```
|
||||
|
||||
{% data reusables.commits.about-commit-cleanup %}
|
||||
|
||||
{% ifversion status-check-retention %}
|
||||
|
||||
### Retention of status checks
|
||||
|
||||
1
data/reusables/commits/about-commit-cleanup.md
Normal file
1
data/reusables/commits/about-commit-cleanup.md
Normal file
@@ -0,0 +1 @@
|
||||
By default, Git automatically removes consecutive newlines. To leave the commit message exactly as you entered it, use the `--cleanup=verbatim` option on your commit. For more information, see [`--cleanup=<mode>`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---cleanupltmodegt) in the Git documentation.
|
||||
Reference in New Issue
Block a user