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.94.0 (build b380f01)",
           date="2024-01-10T23:18:45.442Z")
@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	setupGitIdentity(SetupGitIdentityOptions options)	(experimental) Configures the git identity (user name and email).
static JobStep	uploadArtifact(UploadArtifactOptions options)

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.

Returns:

Job steps

checkout

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

(experimental) Checks out a repository.

Returns:

Job steps

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 steps

uploadArtifact

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

Parameters:

options - This parameter is required.