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

Class GitMaterial

java.lang.Object

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

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

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

cd.go.contrib.plugins.configrepo.groovy.dsl.ScmMaterial<GitMaterial>

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

All Implemented Interfaces:

Configurable, KeyVal.Mixin, Notifies.MaterialMixin, UtilsMixin

public class GitMaterial
extends ScmMaterial<GitMaterial>

Represents a git material config.

/*
* 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.
*/


pipeline('docs-website') {
materials {
git {
url = 'https://github.com/gocd/gocd'
branch = 'develop'
blacklist = ['README.md', 'docs/**']
username = 'bob'
// see https://api.gocd.org/current/#encrypt-a-plain-text-value
encryptedPassword = 'aSdiFgRRZ6A='
}
}
}


See Also:

• git material config

Constructor Summary

Constructors

Constructor	Description
GitMaterial()
GitMaterial(Closure<?> cl)
GitMaterial(String name, Closure<?> cl)
GitMaterial(String name, Consumer<GitMaterial> configure)

Method Summary

Modifier and Type	Method	Description
GitMaterial	dup(Closure<?> config)
boolean	equals(Object o)
String	getBranch()	The git branch.
Boolean	getShallowClone()	Add a --depth=N option to git cloning command on GoCD agent.
String	getUrl()	The url of the git repository.
int	hashCode()
void	setBranch(String branch)	The git branch.
void	setShallowClone(Boolean shallowClone)	Add a --depth=N option to git cloning command on GoCD agent.
void	setUrl(String url)	The url of the git repository.
String	toString()

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

getAutoUpdate, getBlacklist, getDestination, getEncryptedPassword, getPassword, getUsername, getWhitelist, setAutoUpdate, setBlacklist, setDestination, setEncryptedPassword, setPassword, setUsername, setWhitelist

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

getName, setName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

configure

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

lookup, lookup

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

notifiesBitbucketAt, notifiesBitbucketSelfHostedAt, notifiesBy, notifiesGitHubAt, notifiesGitLabAt

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

sanitizeName

Constructor Details

GitMaterial

public GitMaterial()

GitMaterial

public GitMaterial(@DelegatesTo(value=GitMaterial.class,strategy=3)
 Closure<?> cl)

GitMaterial

public GitMaterial(String name,
 @DelegatesTo(value=GitMaterial.class,strategy=3)
 Closure<?> cl)

GitMaterial

public GitMaterial(String name,
 Consumer<GitMaterial> configure)

Method Details

dup

public GitMaterial dup(@DelegatesTo(value=GitMaterial.class,strategy=3)
 Closure<?> config)

Specified by:

dup in class Material<GitMaterial>

getUrl

public String getUrl()

The url of the git repository.

getBranch

public String getBranch()

The git branch. Defaults to master.

getShallowClone

public Boolean getShallowClone()

Add a --depth=N option to git cloning command on GoCD agent. Shallow clone truncates history to latest revisions, thus helps accelerating clone operation for repositories with long history.

Clone depth is dynamically calculated to ensure revisions from GO_FROM_REVISION to GO_TO_REVISION are included in the cloned repository.

setUrl

public void setUrl(String url)

The url of the git repository.

setBranch

public void setBranch(String branch)

The git branch. Defaults to master.

setShallowClone

public void setShallowClone(Boolean shallowClone)

Add a --depth=N option to git cloning command on GoCD agent. Shallow clone truncates history to latest revisions, thus helps accelerating clone operation for repositories with long history.

Clone depth is dynamically calculated to ensure revisions from GO_FROM_REVISION to GO_TO_REVISION are included in the cloned repository.

equals

public boolean equals(Object o)

Overrides:

equals in class ScmMaterial<GitMaterial>

hashCode

public int hashCode()

Overrides:

hashCode in class ScmMaterial<GitMaterial>

toString

public String toString()

Overrides:

toString in class ScmMaterial<GitMaterial>