Package io.github.cdklabs.projen.github.workflows

Interface PushOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

PullRequestOptions, PullRequestTargetOptions

All Known Implementing Classes:

PullRequestOptions.Jsii$Proxy, PullRequestTargetOptions.Jsii$Proxy, PushOptions.Jsii$Proxy

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

(experimental) Options for push-like events.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PushOptions.Builder	builder()
default List<String>	getBranches()	(experimental) When using the push, pull_request and pull_request_target events, you can configure a workflow to run on specific branches or tags.
default List<String>	getPaths()	(experimental) When using the push, pull_request and pull_request_target events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths.
default List<String>	getTags()	(experimental) When using the push, pull_request and pull_request_target events, you can configure a workflow to run on specific branches or tags.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBranches

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

(experimental) When using the push, pull_request and pull_request_target events, you can configure a workflow to run on specific branches or tags.

For a pull_request event, only branches and tags on the base are evaluated. If you define only tags or only branches, the workflow won't run for events affecting the undefined Git ref.

See Also:

https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet

getPaths

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

(experimental) When using the push, pull_request and pull_request_target events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths.

Path filters are not evaluated for pushes to tags.

See Also:

https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet

getTags

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

(experimental) When using the push, pull_request and pull_request_target events, you can configure a workflow to run on specific branches or tags.

For a pull_request event, only branches and tags on the base are evaluated. If you define only tags or only branches, the workflow won't run for events affecting the undefined Git ref.

See Also:

https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet

builder

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

Returns:

a PushOptions.Builder of PushOptions