Skip to content

Commit f44fc16

Browse files
StartAutomatingStartAutomating
StartAutomating
authored and
StartAutomating
committed
feat: git commit -SkipCI ( Fixes #320 )
1 parent a8518e1 commit f44fc16

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/Git.Commit.Input-Extension.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -147,9 +147,18 @@ If provided, will mark this commit as on-behalf-of one or more people.
147147
|------------|--------|--------|---------------------|--------|
148148
|`[String[]]`|false |named |true (ByPropertyName)|OnBehalf|
149149

150+
#### **SkipCI**
151+
If set, will add `[skip ci]` to the commit message.
152+
This will usually prevent a CI/CD system from running a build.
153+
This is supported by GitHub Workflows, Azure DevOps Pipelines, and GitLab (to name a few).
154+
155+
|Type |Required|Position|PipelineInput|Aliases |
156+
|----------|--------|--------|-------------|----------------------------------------------|
157+
|`[Switch]`|false |named |false |CISkip<br/>NoCI<br/>SkipActions<br/>ActionSkip|
158+
150159
---
151160

152161
### Syntax
153162
```PowerShell
154-
Extensions/Git.Commit.Input.UGit.Extension.ps1 [-Title <String>] [-Message <String>] [-Type <String>] [-Scope <String>] [-Description <String>] [-Footer <String>] [-Body <String>] [-Trailers <IDictionary>] [-Amend] [-CommitDate <DateTime>] [-Fix <String[]>] [-Close <String[]>] [-Resolve <String[]>] [-Reference <String[]>] [-CoAuthoredBy <String[]>] [-OnBehalfOf <String[]>] [<CommonParameters>]
163+
Extensions/Git.Commit.Input.UGit.Extension.ps1 [-Title <String>] [-Message <String>] [-Type <String>] [-Scope <String>] [-Description <String>] [-Footer <String>] [-Body <String>] [-Trailers <IDictionary>] [-Amend] [-CommitDate <DateTime>] [-Fix <String[]>] [-Close <String[]>] [-Resolve <String[]>] [-Reference <String[]>] [-CoAuthoredBy <String[]>] [-OnBehalfOf <String[]>] [-SkipCI] [<CommonParameters>]
155164
```

0 commit comments

Comments
 (0)