Property Detail

• java.lang.String stagingRelpath

  The relative path to use when running the wrench locally as part of the build. Defaults to .wrench. It is best not to override this value.

• java.io.File wrenchFile

  The wrench file. Normally derived from the file name but can be set explicitly. This is very rarely needed.

• java.lang.String wrenchFileName

  The wrench file name. Defaults to runbook.wrench.

Constructor Detail

• PlanStaging(java.util.Map options)

  Constructor. The map parameter may be empty or may hold:

  • wrenchFileName: Overrides the wrench file name
  • wrenchFile: Sets the wrench file explicitly
  • stagingRelpath: Changes the default staging location

  Parameters:

  options - The options map, which may be empty or null

• PlanStaging()

  Constructor that applies default values.

Method Detail

• void apply(org.gradle.api.Project project)

  Configures the parameter project to build a wrench.

  Parameters:

  project - The project to configure

• static void applyStagingPlugin(org.gradle.api.Project project)

  Applies the staging plugin to the project

  Parameters:

  project - The project being configured

• void applyWrench(org.gradle.api.Project project)

• void configureBuild(org.gradle.api.Project project)

• void configureBuildTasks(org.gradle.api.Project project)

• void configureDelegation(org.gradle.api.Project project)

• void configureDelegation(org.gradle.api.Project project, java.lang.String taskName, java.lang.String nodeName, java.lang.String qualifier)

• org.gradle.api.Task configureGradleBuild(org.gradle.api.Project project, java.util.Map target, org.gradle.api.Task start)

  Creates the task to create the Gradle build file for executing the wrench.

  This build file is not related to the parameter project. Instead it defines a complete Gradle build. See notes in the class header.

  Parameters:

  project - The project being configured

  target - The target being configured

  start - A start dependency that must execute first

  Returns:

  The created and configured task to create the Gradle build file

• org.gradle.api.Task configureGradlePropertiesTask(org.gradle.api.Project project, java.util.Map target, org.gradle.api.Task previous)

• org.gradle.api.tasks.Copy configureGradleWrapperTask(org.gradle.api.Project project, java.util.Map target, org.gradle.api.Task start)

  Creates the task to put in place the Gradle wrapper for executing the wrench.

  Parameters:

  project - The project being configured

  target - The target being configured

  start - A start dependency that must execute first

  Returns:

  The created and configured task to establish the Gradle wrapper

• void configureMainTasks(org.gradle.api.Project project)

• void configurePublishing(org.gradle.api.Project project)

• org.gradle.api.tasks.Copy configureRunbookTask(org.gradle.api.Project project, java.util.Map target, org.gradle.api.Task previous)

• org.gradle.api.DefaultTask configureSettingsTask(org.gradle.api.Project project, java.util.Map target, org.gradle.api.Task previous)

• void configureStageTask(org.gradle.api.Project project)

• void configureStagingExtension(org.gradle.api.Project project)

  Configures the staging extension with targets.

  Parameters:

  project - The project being configured

• void configureTarget(org.gradle.api.Project project, java.util.Map target, org.gradle.api.Task start)

  Configures an individual target defined by the staging extension.

  Parameters:

  project - The project being configured

  target - The target being configured

  start - A start dependency that needs to execute before the target tasks

• void configureTargets(org.gradle.api.Project project, org.gradle.api.Task start)

  Configures the targets defined by the staging extension.

  Parameters:

  project - The project being configured

• static void configureVelocityTask(org.gradle.api.Project project)

  Configures the target-agnostic Velocity template instantiation that executes before any target tasks; not yet configurable; hardcoded.

  Parameters:

  project - The project being configured

• java.io.File findWrenchFile(org.gradle.api.Project project)

  Locates the wrench file the project should build, or throws.

  throws:

  GradleException If the wrench file is not found

  Parameters:

  project - The project that builds the wrench

  Returns:

  The wrench file the project builds

• java.lang.String getEnvironmentName(org.gradle.api.Project project, java.lang.String suffix)

• java.io.File getStagingDir(org.gradle.api.Project project, java.util.Map target)

• void instantiateBuildTemplate(org.gradle.api.Project project, java.util.Map target)