Full name:
com.github.github:site-maven-plugin:0.9:site
Description:
Attributes:
Name | Type | Since | Description |
---|---|---|---|
message | String | - | The commit message used when committing the site. |
outputDirectory | File | - | The base directory to commit files from. target/site by
default. Default value is: ${project.reporting.outputDirectory}. User property is: siteOutputDirectory. |
project | MavenProject | - | The project being built User property is: project. |
Name | Type | Since | Description |
---|---|---|---|
branch | String | - | Branch to update Default value is: refs/heads/gh-pages. |
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. User property is: github.site.dryRun. |
excludes | String[] | - | Paths and patterns to exclude |
force | boolean | - | Force reference update User property is: github.site.force. |
host | String | - | The Host for API calls. Default value is: ${github.global.host}. User property is: github.site.host. |
includes | String[] | - | Paths and patterns to include |
merge | boolean | - | Set it to true to merge with existing the existing
tree that is referenced by the commit that the ref currently points
to User property is: github.site.merge. |
noJekyll | boolean | - | Set it to true to always create a '.nojekyll' file at
the root of the site if one doesn't already exist. User property is: github.site.noJekyll. |
oauth2Token | String | - | The oauth2 token for authentication Default value is: ${github.global.oauth2Token}. User property is: github.site.oauth2Token. |
password | String | - | The password for authentication Default value is: ${github.global.password}. User property is: github.site.password. |
path | String | - | Path of tree |
repositoryName | String | - | The name of the repository. This setting must be set if the
project's url and scm metadata are not set. User property is: github.site.repositoryName. |
repositoryOwner | String | - | The owner of repository. This setting must be set if the project's
url and scm metadata are not set. User property is: github.site.repositoryOwner. |
server | String | - | The id of the server to use to retrieve the Github
credentials. This id must identify a server from your
setting.xml file. Default value is: ${github.global.server}. User property is: github.site.server. |
session | MavenSession | - | The Maven session User property is: session. |
settings | Settings | - | The Maven settings User property is: settings. |
skip | boolean | 0.9 | Skip the site upload. Default value is: false. User property is: github.site.skip. |
userName | String | - | The user name for authentication Default value is: ${github.global.userName}. User property is: github.site.userName. |
host:
path:
skip: