Groovy Documentation

org.ajoberstar.gradle.git.plugins
[Groovy] Class GithubPagesPluginExtension

java.lang.Object
  org.ajoberstar.gradle.git.plugins.GithubPagesPluginExtension
All Implemented Interfaces:
AuthenticationSupported

class GithubPagesPluginExtension

Extension for gh-pages specific properties.

Since:
0.1.0


Property Summary
PasswordCredentials credentials

CopySpec pages

The distribution of files to put in gh-pages.

java.lang.Object repoUri

The URI of the Github repository.

java.lang.Object workingPath

The path to put the github repository in.

 
Constructor Summary
GithubPagesPluginExtension(Project project)

Constructs the plugin extension.

 
Method Summary
void credentials(groovy.lang.Closure closure)

Configured the credentials to be used when interacting with the repo.

java.lang.String getRepoUri()

Gets the URI of the Github repository.

java.io.File getWorkingDir()

Gets the working directory that the repo will be places in.

void pages(groovy.lang.Closure closure)

Configures the gh-pages copy spec.

 
Methods inherited from class java.lang.Object
java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Property Detail

credentials

PasswordCredentials credentials


pages

final CopySpec pages
The distribution of files to put in gh-pages.


repoUri

java.lang.Object repoUri
The URI of the Github repository.


workingPath

java.lang.Object workingPath
The path to put the github repository in.


 
Constructor Detail

GithubPagesPluginExtension

GithubPagesPluginExtension(Project project)
Constructs the plugin extension.
Parameters:
project - the project to create the extension for


 
Method Detail

credentials

void credentials(groovy.lang.Closure closure)
Configured the credentials to be used when interacting with the repo. This will be passed a PasswordCredentials instance.
Parameters:
closure - the configuration closure


getRepoUri

java.lang.String getRepoUri()
Gets the URI of the Github repository. This will be used to clone the repository.
Returns:
the repo URI


getWorkingDir

java.io.File getWorkingDir()
Gets the working directory that the repo will be places in.
Returns:
the working directory


pages

void pages(groovy.lang.Closure closure)
Configures the gh-pages copy spec.
Parameters:
closure - the configuration closure


 

Groovy Documentation