Required Parameters

Name	Type	Since	Description
message	String	-	Commit message

Optional Parameters

Name	Type	Since	Description
branch	String	-	Branch to update Default value is: refs/heads/gh-pages.
createSamplePost	boolean	-	(no description) Default value is: true.
dryRun	boolean	-	Show what blob, trees, commits, and references would be created/updated but don't actually perform any operations on the target GitHub repository.
excludes	String[]	-	Paths and patterns to exclude
force	boolean	-	Force reference update
host	String	-	Host for API calls Default value is: ${github.global.host}.
includes	String[]	-	Paths and patterns to include
locale	String	-	(no description)
merge	boolean	-	Merge with existing the existing tree that is referenced by the commit that the ref currently points to
noJekyll	boolean	-	True to always create a '.nojekyll' file at the root of the site if one doesn't already exist. Default value is: true.
numThreads	int	-	(no description) Default value is: 1.
oauth2Token	String	-	User name for authentication Default value is: ${github.global.oauth2Token}.
password	String	-	User name for authentication Default value is: ${github.global.password}.
repositoryName	String	-	Name of repository
repositoryOwner	String	-	Owner of repository
server	String	-	Id of server to use Default value is: ${github.global.server}.
settings	Settings	-	Settings
skipDeploy	boolean	-	Set this to 'true' to skip deployment. Default value is: false.
skipGenerate	boolean	-	Set this to 'true' to skip generate. Default value is: false.
skipInstall	boolean	-	Set this to 'true' to skip install. Default value is: false.
skipSassCompile	boolean	-	Set this to 'true' to skip SASS/SCSS compile. Default value is: false.
userName	String	-	User name for authentication Default value is: ${github.global.userName}.

Parameter Details

branch:

• Type: java.lang.String
• Required: No
• Expression: ${github.site.branch}
• Default: refs/heads/gh-pages

---

createSamplePost:

• Type: boolean
• Required: No
• Expression: ${op.sample.post}
• Default: true

---

dryRun:

• Type: boolean
• Required: No
• Expression: ${github.site.dryRun}

---

excludes:

• Type: java.lang.String[]
• Required: No

---

force:

• Type: boolean
• Required: No
• Expression: ${github.site.force}

---

host:

• Type: java.lang.String
• Required: No
• Expression: ${github.site.host}
• Default: ${github.global.host}

---

includes:

• Type: java.lang.String[]
• Required: No

---

locale:

• Type: java.lang.String
• Required: No
• Expression: ${locale}

---

merge:

• Type: boolean
• Required: No
• Expression: ${github.site.merge}

---

message:

• Type: java.lang.String
• Required: Yes
• Expression: ${github.site.commit.message}

---

noJekyll:

• Type: boolean
• Required: No
• Expression: ${github.site.noJekyll}
• Default: true

---

numThreads:

• Type: int
• Required: No
• Expression: ${github.site.numThreads}
• Default: 1

---

oauth2Token:

• Type: java.lang.String
• Required: No
• Expression: ${github.site.oauth2Token}
• Default: ${github.global.oauth2Token}

---

password:

• Type: java.lang.String
• Required: No
• Expression: ${github.site.password}
• Default: ${github.global.password}

---

repositoryName:

• Type: java.lang.String
• Required: No
• Expression: ${github.site.repositoryName}

---

repositoryOwner:

• Type: java.lang.String
• Required: No
• Expression: ${github.site.repositoryOwner}

---

server:

• Type: java.lang.String
• Required: No
• Expression: ${github.site.server}
• Default: ${github.global.server}

---

settings:

• Type: org.apache.maven.settings.Settings
• Required: No
• Expression: ${settings}

---

skipDeploy:

• Type: boolean
• Required: No
• Expression: ${op.deploy.skip}
• Default: false

---

skipGenerate:

• Type: boolean
• Required: No
• Expression: ${op.generate.skip}
• Default: false

---

skipInstall:

• Type: boolean
• Required: No
• Expression: ${op.install.skip}
• Default: false

---

skipSassCompile:

• Type: boolean
• Required: No
• Expression: ${op.sass.compile.skip}
• Default: false

---

userName:

• Type: java.lang.String
• Required: No
• Expression: ${github.site.userName}
• Default: ${github.global.userName}