Package io.github.cdklabs.projen.gitlab

Interface Include

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Include.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.121Z")
@Stability(Experimental)
public interface Include
extends software.amazon.jsii.JsiiSerializable

(experimental) An included YAML file.

See Also:

https://docs.gitlab.com/ee/ci/yaml/#include

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Include.Builder	A builder for Include
static class	Include.Jsii$Proxy	An implementation for Include

Method Summary

Modifier and Type	Method	Description
static Include.Builder	builder()
default List<String>	getFile()	(experimental) Files from another private project on the same GitLab instance.
default String	getLocal()	(experimental) Relative path from local repository root (/) to the yaml/yml file template.
default String	getProject()	(experimental) Path to the project, e.g.
default String	getRef()	(experimental) Branch/Tag/Commit-hash for the target project.
default String	getRemote()	(experimental) URL to a yaml/yml template file using HTTP/HTTPS.
default List<IncludeRule>	getRules()	(experimental) Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job.
default String	getTemplate()	(experimental) Use a .gitlab-ci.yml template as a base, e.g.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFile

@Stability(Experimental)
@Nullable
default List<String> getFile()

(experimental) Files from another private project on the same GitLab instance.

You can use file in combination with project only.

getLocal

@Stability(Experimental)
@Nullable
default String getLocal()

(experimental) Relative path from local repository root (/) to the yaml/yml file template.

The file must be on the same branch, and does not work across git submodules.

getProject

@Stability(Experimental)
@Nullable
default String getProject()

(experimental) Path to the project, e.g. group/project, or group/sub-group/project.

getRef

@Stability(Experimental)
@Nullable
default String getRef()

(experimental) Branch/Tag/Commit-hash for the target project.

getRemote

@Stability(Experimental)
@Nullable
default String getRemote()

(experimental) URL to a yaml/yml template file using HTTP/HTTPS.

getRules

@Stability(Experimental)
@Nullable
default List<IncludeRule> getRules()

(experimental) Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job.

getTemplate

@Stability(Experimental)
@Nullable
default String getTemplate()

(experimental) Use a .gitlab-ci.yml template as a base, e.g. Nodejs.gitlab-ci.yml.

builder

@Stability(Experimental)
static Include.Builder builder()

Returns:

a Include.Builder of Include