dionysus:prepare-branch
Prepare Github pages branch for publishing.
- Full name
- org.sonatype.goodies.dionysus:dionysus-maven-plugin:1.0.3:prepare-branch
- Since
- 1.0.0
- Requires Project
- true
- Requires Online
- false
- Requires Direct Invocation
- true
- Thread-safe
- false
Parameters
4 parameters
| Name |
Type |
Since |
Description |
| checkoutDir |
java.io.File |
|
Directory where a checkout to perform changes will be done. |
| dryRun |
boolean |
|
Set to avoid push of final changes. |
| gitBranch |
java.lang.String |
|
The branch where content will be published. All content on this
branch will be replaced by what is generated. |
| gitExecutable |
java.lang.String |
|
GIT executable to use. |
checkoutDir
Directory where a checkout to perform changes will be done.
- Type
- java.io.File
- Required
- true
- Default Value
- ${project.build.directory}/prepare-checkout
- User Property
- ${dionysus.checkoutDir}
dryRun
Set to avoid push of final changes.
- Type
- boolean
- Required
- false
- Default Value
- false
- User Property
- ${dionysus.dryRun}
gitBranch
The branch where content will be published. All content on this
branch will be replaced by what is generated.
- Type
- java.lang.String
- Required
- true
- Default Value
- gh-pages
- User Property
- ${dionysus.gitBranch}
gitExecutable
GIT executable to use.
- Type
- java.lang.String
- Required
- true
- Default Value
- git
- User Property
- ${dionysus.gitExecutable}