This task creates target-specific staging binaries.
A staging binary is a zip file containing target-specific resources. The targets normally correspond to application environments like development or production but targets can also correspond to hosts, or any other logical unit for which an independent set of resources is required.
The execution sequence is as follows:
build/vtl.build/templates.build/resources/main.build/targets.build/lib/*.zip.The staging tasks don't support source sets properly. Instead of the
build/targets directory, build/targets/main
should be used, etc.
The generated archives are zip files, without jar manifests.
| Fields inherited from class | Fields |
|---|---|
class org.gradle.api.DefaultTask |
TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS |
| Type | Name and description |
|---|---|
java.lang.Boolean |
includeAllResourcesIf this property is set to true then the task will use all available resources when creating the staging binary for each target; if the property is set to false then the task only considers resources with base names that are suffixed by the target name. |
org.gradle.api.provider.MapProperty<java.lang.String, java.lang.Object> |
targetsDefines the targets to produce staging binaries for. |
| Constructor and description |
|---|
Stage
() |
| Type Params | Return Type | Name and description |
|---|---|---|
|
void |
apply() |
|
void |
checkTarget(java.util.Map target) |
|
org.gradle.api.Task |
configure(groovy.lang.Closure closure) |
|
void |
configureArtifactPublishing(java.util.Map target, org.gradle.api.artifacts.PublishArtifact targetArtifact) |
|
void |
configureTarget(java.util.Map target) |
|
void |
configureTargets() |
|
org.gradle.api.tasks.bundling.Zip |
createArchiveTask(java.util.Map target, org.gradle.api.Task previous) |
|
org.gradle.api.tasks.Copy |
createResourcesTask(java.util.Map target, org.gradle.api.Task dependency, java.lang.String inputPath) |
|
com.brambolt.gradle.velocity.tasks.Velocity |
createTargetVelocityTask(java.util.Map target, org.gradle.api.Task dependency) |
|
org.gradle.api.artifacts.PublishArtifact |
createZipArtifact(java.util.Map target, org.gradle.api.tasks.bundling.Zip zip) |
|
static java.lang.String |
getArtifactId(org.gradle.api.Project project)Provides the artifact identifier for the generated archives. |
|
groovy.lang.Closure<java.lang.String> |
getNameFilter(java.util.Map target) |
|
java.lang.String |
getResourceInclusion(java.util.Map target) |
|
static java.io.File |
getResourcesDir(org.gradle.api.Project project, java.util.Map target) |
|
static java.io.File |
getTemplatesDir(org.gradle.api.Project project, java.util.Map target) |
|
void |
setResourcesDirs() |
| Methods inherited from class | Name |
|---|---|
class org.gradle.api.DefaultTask |
org.gradle.api.DefaultTask#getProject(), org.gradle.api.DefaultTask#setDescription(java.lang.String), org.gradle.api.DefaultTask#getIdentityPath(), org.gradle.api.DefaultTask#getStandardOutputCapture(), org.gradle.api.DefaultTask#setGroup(java.lang.String), org.gradle.api.DefaultTask#getAnt(), org.gradle.api.DefaultTask#getConvention(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#getDidWork(), org.gradle.api.DefaultTask#getAsDynamicObject(), org.gradle.api.DefaultTask#mustRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#setMustRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#getMustRunAfter(), org.gradle.api.DefaultTask#finalizedBy([Ljava.lang.Object;), org.gradle.api.DefaultTask#setFinalizedBy(java.lang.Iterable), org.gradle.api.DefaultTask#getFinalizedBy(), org.gradle.api.DefaultTask#shouldRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#usesService(org.gradle.api.provider.Provider), org.gradle.api.DefaultTask#getShouldRunAfter(), org.gradle.api.DefaultTask#doFirst(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#doFirst(org.gradle.api.Action), org.gradle.api.DefaultTask#doFirst(groovy.lang.Closure), org.gradle.api.DefaultTask#doLast(org.gradle.api.Action), org.gradle.api.DefaultTask#doLast(groovy.lang.Closure), org.gradle.api.DefaultTask#doLast(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#getEnabled(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getDestroyables(), org.gradle.api.DefaultTask#getLocalState(), org.gradle.api.DefaultTask#getTemporaryDir(), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#onlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#setDidWork(boolean), org.gradle.api.DefaultTask#getDependsOn(), org.gradle.api.DefaultTask#setDependsOn(java.lang.Iterable), org.gradle.api.DefaultTask#dependsOn([Ljava.lang.Object;), org.gradle.api.DefaultTask#setShouldRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#setActions(java.util.List), org.gradle.api.DefaultTask#getTaskIdentity(), org.gradle.api.DefaultTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.gradle.api.DefaultTask#getTaskActions(), org.gradle.api.DefaultTask#hasTaskActions(), org.gradle.api.DefaultTask#getOnlyIf(), org.gradle.api.DefaultTask#getImpliesSubProjects(), org.gradle.api.DefaultTask#setImpliesSubProjects(boolean), org.gradle.api.DefaultTask#replaceLogger(org.gradle.api.logging.Logger), org.gradle.api.DefaultTask#getTemporaryDirFactory(), org.gradle.api.DefaultTask#prependParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#appendParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#isHasCustomActions(), org.gradle.api.DefaultTask#getRequiredServices(), org.gradle.api.DefaultTask#getSharedResources(), org.gradle.api.DefaultTask#getTimeout(), org.gradle.api.DefaultTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.DefaultTask#compareTo(java.lang.Object), org.gradle.api.DefaultTask#compareTo(org.gradle.api.Task), org.gradle.api.DefaultTask#getName(), org.gradle.api.DefaultTask#getActions(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getPath(), org.gradle.api.DefaultTask#getExtensions(), org.gradle.api.DefaultTask#getLogger(), org.gradle.api.DefaultTask#property(java.lang.String), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#isEnabled(), org.gradle.api.DefaultTask#getDescription(), org.gradle.api.DefaultTask#setEnabled(boolean), org.gradle.api.DefaultTask#hasProperty(java.lang.String), org.gradle.api.DefaultTask#getGroup(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#wait(long, int), org.gradle.api.DefaultTask#wait(long), org.gradle.api.DefaultTask#wait(), org.gradle.api.DefaultTask#equals(java.lang.Object), org.gradle.api.DefaultTask#toString(), org.gradle.api.DefaultTask#hashCode(), org.gradle.api.DefaultTask#getClass(), org.gradle.api.DefaultTask#notify(), org.gradle.api.DefaultTask#notifyAll() |
If this property is set to true then the task will use all available resources when creating the staging binary for each target; if the property is set to false then the task only considers resources with base names that are suffixed by the target name. Defaults to false.
For example, if there are two targets dev and
test and three resources file1.txt,
file2.txt.dev and file2.txt.test then the
default behavior is to ignore file1.txt and produce two
staging binaries that each contains a file named file2.txt.
If on the other hand the property is set to true then each binary will contain all three resources and the target name suffixes will not be removed from the file names.
The sensible uses are to either set the property to false and include target suffixes on all file names, or set the property to true and remove all target suffixes from the file names.
Defines the targets to produce staging binaries for.
Provides the artifact identifier for the generated archives. This is
either project.ext.artifactId or (by default) the project
name.
Every staging binary shares the same artifact identifier. The staging binaries are distinguished by the artifact classifier, which is always set to the target name for the respective artifact.
project - The project the task belongs toGroovy Documentation