Fork me on GitHub

site:site

Full name:

com.github.github:site-maven-plugin:0.9:site

Description:

Mojo which copies files to a GitHub repository branch. This directly uses the GitHub data API to upload blobs, make commits, and update references and so a local Git repository is not used.

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

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.

Optional Parameters

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.

Parameter Details

branch:

Branch to update
  • Type: java.lang.String
  • Required: No
  • Default: refs/heads/gh-pages

dryRun:

Show what blob, trees, commits, and references would be created/updated but don't actually perform any operations on the target GitHub repository.
  • Type: boolean
  • Required: No
  • User Property: github.site.dryRun

excludes:

Paths and patterns to exclude
  • Type: java.lang.String[]
  • Required: No

force:

Force reference update
  • Type: boolean
  • Required: No
  • User Property: github.site.force

host:

The Host for API calls.
  • Type: java.lang.String
  • Required: No
  • User Property: github.site.host
  • Default: ${github.global.host}

includes:

Paths and patterns to include
  • Type: java.lang.String[]
  • Required: No

merge:

Set it to true to merge with existing the existing tree that is referenced by the commit that the ref currently points to
  • Type: boolean
  • Required: No
  • User Property: github.site.merge

message:

The commit message used when committing the site.
  • Type: java.lang.String
  • Required: Yes

noJekyll:

Set it to true to always create a '.nojekyll' file at the root of the site if one doesn't already exist.
  • Type: boolean
  • Required: No
  • User Property: github.site.noJekyll

oauth2Token:

The oauth2 token for authentication
  • Type: java.lang.String
  • Required: No
  • User Property: github.site.oauth2Token
  • Default: ${github.global.oauth2Token}

outputDirectory:

The base directory to commit files from. target/site by default.
  • Type: java.io.File
  • Required: Yes
  • User Property: siteOutputDirectory
  • Default: ${project.reporting.outputDirectory}

password:

The password for authentication
  • Type: java.lang.String
  • Required: No
  • User Property: github.site.password
  • Default: ${github.global.password}

path:

Path of tree
  • Type: java.lang.String
  • Required: No

project:

The project being built
  • Type: org.apache.maven.project.MavenProject
  • Required: Yes
  • User Property: project

repositoryName:

The name of the repository. This setting must be set if the project's url and scm metadata are not set.
  • Type: java.lang.String
  • Required: No
  • User Property: github.site.repositoryName

repositoryOwner:

The owner of repository. This setting must be set if the project's url and scm metadata are not set.
  • Type: java.lang.String
  • Required: No
  • User Property: github.site.repositoryOwner

server:

The id of the server to use to retrieve the Github credentials. This id must identify a server from your setting.xml file.
  • Type: java.lang.String
  • Required: No
  • User Property: github.site.server
  • Default: ${github.global.server}

session:

The Maven session
  • Type: org.apache.maven.execution.MavenSession
  • Required: No
  • User Property: session

settings:

The Maven settings
  • Type: org.apache.maven.settings.Settings
  • Required: No
  • User Property: settings

skip:

Skip the site upload.
  • Type: boolean
  • Since: 0.9
  • Required: No
  • User Property: github.site.skip
  • Default: false

userName:

The user name for authentication
  • Type: java.lang.String
  • Required: No
  • User Property: github.site.userName
  • Default: ${github.global.userName}