Package io.github.cdklabs.projen.github

Class WorkflowSteps

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.github.WorkflowSteps

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.094Z")
@Stability(Experimental)
public class WorkflowSteps
extends software.amazon.jsii.JsiiObject

(experimental) A collection of very commonly used, individual, GitHub Workflow Job steps.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
	WorkflowSteps()
protected	WorkflowSteps(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	WorkflowSteps(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static JobStep	checkout()	(experimental) Checks out a repository.
static JobStep	checkout(CheckoutOptions options)	(experimental) Checks out a repository.
static JobStep	downloadArtifact()	(experimental) Downloads an artifact.
static JobStep	downloadArtifact(DownloadArtifactOptions options)	(experimental) Downloads an artifact.
static JobStep	setupGitIdentity(SetupGitIdentityOptions options)	(experimental) Configures the git identity (user name and email).
static JobStep	tagExists(String tag, JobStepConfiguration options)	(experimental) Checks if a tag exists.
static JobStep	uploadArtifact(UploadArtifactOptions options)	(experimental) Uploads an artifact.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

WorkflowSteps

protected WorkflowSteps(software.amazon.jsii.JsiiObjectRef objRef)

WorkflowSteps

protected WorkflowSteps(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

WorkflowSteps

@Stability(Experimental)
public WorkflowSteps()

Method Detail

checkout

@Stability(Experimental)
@NotNull
public static JobStep checkout(@Nullable
                               CheckoutOptions options)

(experimental) Checks out a repository.

Parameters:

options - Options to configure the checkout JobStep.

Returns:

A JobStep that checks out a repository

checkout

@Stability(Experimental)
@NotNull
public static JobStep checkout()

(experimental) Checks out a repository.

Returns:

A JobStep that checks out a repository

downloadArtifact

@Stability(Experimental)
@NotNull
public static JobStep downloadArtifact(@Nullable
                                       DownloadArtifactOptions options)

(experimental) Downloads an artifact.

Parameters:

options - Options to configure the download-artifact JobStep.

Returns:

A JobStep that downloads an artifact

downloadArtifact

@Stability(Experimental)
@NotNull
public static JobStep downloadArtifact()

(experimental) Downloads an artifact.

Returns:

A JobStep that downloads an artifact

setupGitIdentity

@Stability(Experimental)
@NotNull
public static JobStep setupGitIdentity(@NotNull
                                       SetupGitIdentityOptions options)

(experimental) Configures the git identity (user name and email).

Parameters:

options - Options to configure the git identity JobStep. This parameter is required.

Returns:

Job step that configures the provided git identity

tagExists

@Stability(Experimental)
@NotNull
public static JobStep tagExists(@NotNull
                                String tag,
                                @NotNull
                                JobStepConfiguration options)

(experimental) Checks if a tag exists.

Requires a checkout step to have been run before this step with "fetch-depth" set to "0".

Outputs:

• exists: A string value of 'true' or 'false' indicating if the tag exists.

Parameters:

tag - The tag to check. This parameter is required.

options - Options to configure the tag-exists JobStep. This parameter is required.

Returns:

Job step that checks if the provided tag exists

uploadArtifact

@Stability(Experimental)
@NotNull
public static JobStep uploadArtifact(@NotNull
                                     UploadArtifactOptions options)

(experimental) Uploads an artifact.

Parameters:

options - Options to configure the upload-artifact JobStep. This parameter is required.

Returns:

A JobStep that uploads an artifact