GithubPagesPluginExtension (gradle-git 1.7.2 API)

org.ajoberstar.gradle.git.ghpages.GithubPagesPluginExtension

All Implemented Interfaces and Traits:

AuthenticationSupported
```
class GithubPagesPluginExtension
```
Extension for gh-pages specific properties.
Since:
0.1.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`GithubPagesPluginExtension.DestinationCopySpec`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`commitMessage` The message used when committing changes to Github pages branch.
`PasswordCredentials`	`credentials`
`boolean`	`deleteExistingFiles` Whether to delete existing files in the branch, replacing the entire contents.
`CopySpec`	`pages` The distribution of files to put in gh-pages.
`java.lang.Object`	`repoUri` The URI of the Github repository.
`java.lang.Object`	`targetBranch` The branch of the Github repository to push to.
`java.lang.Object`	`workingPath` The path to put the github repository in.

Constructor Summary

Constructors
Constructor and description
`GithubPagesPluginExtension (Project project)` Constructs the plugin extension.

Methods Summary

Methods
Type	Name and description
`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.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(), java.lang.Object#wait(long, int), java.lang.Object#wait(long), 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
  - java.lang.String commitMessage
    
    The message used when committing changes to Github pages branch. Defaults to 'Publish of Github pages from Gradle.'.
  - PasswordCredentials credentials
  - boolean deleteExistingFiles
    
    Whether to delete existing files in the branch, replacing the entire contents. Defaults to true.
  - final CopySpec pages
    
    The distribution of files to put in gh-pages. Defaults to including src/main/ghpages.
  - java.lang.Object repoUri
    
    The URI of the Github repository.
  - java.lang.Object targetBranch
    
    The branch of the Github repository to push to. Defaults to gh-pages
  - java.lang.Object workingPath
    
    The path to put the github repository in. Defaults to build/ghpages.
- Constructor Detail
  - GithubPagesPluginExtension(Project project)
    
    Constructs the plugin extension.
    Parameters:
    project - the project to create the extension for
- Method Detail
  - 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
  - java.lang.String getRepoUri()
    
    Gets the URI of the Github repository. This will be used to clone the repository.
    Returns:
    the repo URI
  - java.io.File getWorkingDir()
    
    Gets the working directory that the repo will be places in.
    Returns:
    the working directory
  - void pages(groovy.lang.Closure closure)
    
    Configures the gh-pages copy spec.
    Parameters:
    closure - the configuration closure

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GithubPagesPluginExtension

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String commitMessage

PasswordCredentials credentials

boolean deleteExistingFiles

final CopySpec pages

java.lang.Object repoUri

java.lang.Object targetBranch

java.lang.Object workingPath

Constructor Detail

GithubPagesPluginExtension(Project project)

Method Detail

void credentials(groovy.lang.Closure closure)

java.lang.String getRepoUri()

java.io.File getWorkingDir()

void pages(groovy.lang.Closure closure)