com.github.maven.plugins.site

Class SiteMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.maven.plugins.core.GitHubProjectMojo

com.github.maven.plugins.site.SiteMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class SiteMojo
extends com.github.maven.plugins.core.GitHubProjectMojo

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.

Author:

Kevin Sawicki (kevin@github.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	BRANCH_DEFAULT BRANCH_DEFAULT
static String	NO_JEKYLL_FILE NO_JEKYLL_FILE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
SiteMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	createBlob(org.eclipse.egit.github.core.service.DataService service, org.eclipse.egit.github.core.RepositoryId repository, String path) Create blob
void	execute()

Methods inherited from class com.github.maven.plugins.core.GitHubProjectMojo

configureOAuth2Token, configureServerCredentials, configureUsernamePassword, createClient, createClient, createClient, debug, debug, getExceptionMessage, getRepository, getServer, info, info, isDebug, isInfo

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BRANCH_DEFAULT

public static final String BRANCH_DEFAULT

BRANCH_DEFAULT

See Also:

Constant Field Values

NO_JEKYLL_FILE

public static final String NO_JEKYLL_FILE

NO_JEKYLL_FILE

See Also:

Constant Field Values

Constructor Detail

SiteMojo

public SiteMojo()

Method Detail

createBlob

protected String createBlob(org.eclipse.egit.github.core.service.DataService service,
                org.eclipse.egit.github.core.RepositoryId repository,
                String path)
                     throws org.apache.maven.plugin.MojoExecutionException

Create blob

Parameters:

service -

repository -

path -

Returns:

blob SHA-1

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException