public abstract class MkDocsGhDeploy extends MkDocs
Task.NamerTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE| Constructor and Description |
|---|
MkDocsGhDeploy() |
| Modifier and Type | Method and Description |
|---|---|
abstract RegularFileProperty |
getConfigFile()
Provide a specific MkDocs config.
|
abstract Property<Boolean> |
getForce()
Force the push to the repository.
|
abstract Property<Boolean> |
getIgnoreVersion()
Ignore check that build is not being deployed
with an older version of MkDocs.
|
abstract Property<String> |
getMessage()
A commit message to use when committing to the Github Pages remote branch.
|
abstract Property<String> |
getRemoteBranch()
The remote branch to commit to for Github Pages.
|
abstract Property<String> |
getRemoteName()
The remote name to commit to for Github Pages.
|
exec, getCommand, getExecOperations, getQuiet, getVerbosecompareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdoNotTrackState, getConvention, notCompatibleWithConfigurationCache@Optional @InputFile @PathSensitive(value=RELATIVE) public abstract RegularFileProperty getConfigFile()
@Optional @Input public abstract Property<String> getMessage()
@Optional @Input public abstract Property<String> getRemoteBranch()
@Optional @Input public abstract Property<String> getRemoteName()
@Optional @Input public abstract Property<Boolean> getForce()