Package cd.go.contrib.plugins.configrepo.groovy.dsl

Class Tasks

java.lang.Object

cd.go.contrib.plugins.configrepo.groovy.dsl.Node<T>

cd.go.contrib.plugins.configrepo.groovy.dsl.CollectionNode<Task>

cd.go.contrib.plugins.configrepo.groovy.dsl.Tasks

All Implemented Interfaces:

Configurable, KeyVal.Mixin, UtilsMixin, Iterable<Task>, Collection<Task>, List<Task>

public class Tasks
extends CollectionNode<Task>

Represents a collection of tasks.

Constructor Summary

Constructors

Constructor	Description
Tasks()

Method Summary

Modifier and Type	Method	Description
ShellTask	bash(Closure cl)	Convenience for exec(Closure) task that wraps a command in a bash shell.
boolean	equals(Object o)
ExecTask	exec(Closure cl)	Creates an `exec` task.
FetchArtifactTask	fetchArtifact(Closure cl)
FetchArtifactTask	fetchDirectory(Closure cl)
FetchExternalArtifactTask	fetchExternalArtifact(Closure cl)
FetchArtifactTask	fetchFile(Closure cl)
int	hashCode()
PluginTask	plugin(Closure cl)
ShellTask	shell(Closure cl)	Convenience for exec(Closure) task that wraps a command in a shell.
ShellTask	zsh(Closure cl)	Convenience for exec(Closure) task that wraps a command in a zsh shell.

Methods inherited from class cd.go.contrib.plugins.configrepo.groovy.dsl.CollectionNode

add, add, addAll, addAll, clear, contains, containsAll, create, get, getNames, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface cd.go.contrib.plugins.configrepo.groovy.dsl.mixins.Configurable

configure

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface cd.go.contrib.plugins.configrepo.groovy.dsl.mixins.KeyVal.Mixin

lookup, lookup

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface cd.go.contrib.plugins.configrepo.groovy.dsl.mixins.UtilsMixin

sanitizeName

Constructor Details

Tasks

public Tasks()

Method Details

exec

public ExecTask exec(@DelegatesTo(value=ExecTask.class,strategy=3)
 Closure cl)

Creates an `exec` task.

shell

public ShellTask shell(@DelegatesTo(value=ShellTask.class,strategy=3)
 Closure cl)

Convenience for exec(Closure) task that wraps a command in a shell.

/*
* Copyright 2022 Thoughtworks, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/


tasks {
// for simple evaluation of environment variables
// equivalent of `bash -c 'rsync file user@${REMOTE_HOST}:'`
bash {
commandString = 'rsync file user@${REMOTE_HOST}:'
}

// to explicitly call a shell script using `bash deploy.sh`
bash {
file = "./deploy.sh"
}

// to load up `.profile` or equivalent. This is particularly useful if you're using shell shims like `rvm` or `nvm`
bash {
login = true
// you can also invoke the following method:
loadProfile()
}

// if you want to use a custom shell
shell {
shell = '/bin/fish'
file = './deploy.sh'
}
}


bash

public ShellTask bash(@DelegatesTo(value=ShellTask.class,strategy=3)
 Closure cl)

Convenience for exec(Closure) task that wraps a command in a bash shell.

/*
* Copyright 2022 Thoughtworks, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/


tasks {
// for simple evaluation of environment variables
// equivalent of `bash -c 'rsync file user@${REMOTE_HOST}:'`
bash {
commandString = 'rsync file user@${REMOTE_HOST}:'
}

// to explicitly call a shell script using `bash deploy.sh`
bash {
file = "./deploy.sh"
}

// to load up `.profile` or equivalent. This is particularly useful if you're using shell shims like `rvm` or `nvm`
bash {
login = true
// you can also invoke the following method:
loadProfile()
}

// if you want to use a custom shell
shell {
shell = '/bin/fish'
file = './deploy.sh'
}
}


zsh

public ShellTask zsh(@DelegatesTo(value=ShellTask.class,strategy=3)
 Closure cl)

Convenience for exec(Closure) task that wraps a command in a zsh shell.

/*
* Copyright 2022 Thoughtworks, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/


tasks {
// for simple evaluation of environment variables
// equivalent of `bash -c 'rsync file user@${REMOTE_HOST}:'`
bash {
commandString = 'rsync file user@${REMOTE_HOST}:'
}

// to explicitly call a shell script using `bash deploy.sh`
bash {
file = "./deploy.sh"
}

// to load up `.profile` or equivalent. This is particularly useful if you're using shell shims like `rvm` or `nvm`
bash {
login = true
// you can also invoke the following method:
loadProfile()
}

// if you want to use a custom shell
shell {
shell = '/bin/fish'
file = './deploy.sh'
}
}


fetchArtifact

public FetchArtifactTask fetchArtifact(@DelegatesTo(value=FetchArtifactTask.class,strategy=3)
 Closure cl)

fetchExternalArtifact

public FetchExternalArtifactTask fetchExternalArtifact(@DelegatesTo(value=FetchExternalArtifactTask.class,strategy=3)
 Closure cl)

fetchFile

public FetchArtifactTask fetchFile(@DelegatesTo(value=FetchArtifactTask.class,strategy=3)
 Closure cl)

fetchDirectory

public FetchArtifactTask fetchDirectory(@DelegatesTo(value=FetchArtifactTask.class,strategy=3)
 Closure cl)

plugin

public PluginTask plugin(@DelegatesTo(value=PluginTask.class,strategy=3)
 Closure cl)

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<Task>

Specified by:

equals in interface List<Task>

Overrides:

equals in class CollectionNode<Task>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<Task>

Specified by:

hashCode in interface List<Task>

Overrides:

hashCode in class CollectionNode<Task>