Package io.github.cdklabs.projen.github

Class WorkflowActions

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.github.WorkflowActions

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

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

(experimental) A set of utility functions for creating GitHub actions in workflows.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static List<JobStep>	checkoutWithPatch()	(experimental) Checks out a repository and applies a git patch that was created using uploadGitPatch.
static List<JobStep>	checkoutWithPatch(CheckoutWithPatchOptions options)	(experimental) Checks out a repository and applies a git patch that was created using uploadGitPatch.
static List<JobStep>	createPullRequest(CreatePullRequestOptions options)	(experimental) A step that creates a pull request based on the current repo state.
static List<JobStep>	setupGitIdentity(GitIdentity id)	Deprecated. use WorkflowSteps.setupGitIdentity instead
static List<JobStep>	uploadGitPatch(UploadGitPatchOptions options)	(experimental) Creates a .patch file from the current git diff and uploads it as 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

WorkflowActions

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

WorkflowActions

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

WorkflowActions

@Stability(Experimental)
public WorkflowActions()

Method Detail

checkoutWithPatch

@Stability(Experimental)
@NotNull
public static List<JobStep> checkoutWithPatch(@Nullable
                                              CheckoutWithPatchOptions options)

(experimental) Checks out a repository and applies a git patch that was created using uploadGitPatch.

Parameters:

options - Options.

Returns:

Job steps

checkoutWithPatch

@Stability(Experimental)
@NotNull
public static List<JobStep> checkoutWithPatch()

(experimental) Checks out a repository and applies a git patch that was created using uploadGitPatch.

Returns:

Job steps

createPullRequest

@Stability(Experimental)
@NotNull
public static List<JobStep> createPullRequest(@NotNull
                                              CreatePullRequestOptions options)

(experimental) A step that creates a pull request based on the current repo state.

Parameters:

options - Options. This parameter is required.

Returns:

Job steps

setupGitIdentity

@Stability(Deprecated)
@Deprecated
@NotNull
public static List<JobStep> setupGitIdentity(@NotNull
                                             GitIdentity id)

Deprecated.

use WorkflowSteps.setupGitIdentity instead

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

Parameters:

id - The identity to use. This parameter is required.

Returns:

Job steps

uploadGitPatch

@Stability(Experimental)
@NotNull
public static List<JobStep> uploadGitPatch(@NotNull
                                           UploadGitPatchOptions options)

(experimental) Creates a .patch file from the current git diff and uploads it as an artifact. Use checkoutWithPatch to download and apply in another job.

If a patch was uploaded, the action can optionally fail the job.

Parameters:

options - Options. This parameter is required.

Returns:

Job steps