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

Interface CommonJobDefinition

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

Job, JobCallingReusableWorkflow

All Known Implementing Classes:

CommonJobDefinition.Jsii$Proxy, Job.Jsii$Proxy, JobCallingReusableWorkflow.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CommonJobDefinition.Builder	builder()
default Object	getConcurrency()	(experimental) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.
default String	getIfValue()	(experimental) You can use the if conditional to prevent a job from running unless a condition is met.
default String	getName()	(experimental) The name of the job displayed on GitHub.
default List<String>	getNeeds()	(experimental) Identifies any jobs that must complete successfully before this job will run.
JobPermissions	getPermissions()	(experimental) You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.
default JobStrategy	getStrategy()	(experimental) A strategy creates a build matrix for your jobs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPermissions

@Stability(Experimental)
@NotNull
JobPermissions getPermissions()

(experimental) You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.

Use { contents: READ } if your job only needs to clone code.

This is intentionally a required field since it is required in order to allow workflows to run in GitHub repositories with restricted default access.

See Also:

https://docs.github.com/en/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token

getConcurrency

@Stability(Experimental)
@Nullable
default Object getConcurrency()

(experimental) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.

A concurrency group can be any string or expression. The expression can use any context except for the secrets context.

getIfValue

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

(experimental) You can use the if conditional to prevent a job from running unless a condition is met.

You can use any supported context and expression to create a conditional.

getName

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

(experimental) The name of the job displayed on GitHub.

getNeeds

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

(experimental) Identifies any jobs that must complete successfully before this job will run.

It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional expression that causes the job to continue.

getStrategy

@Stability(Experimental)
@Nullable
default JobStrategy getStrategy()

(experimental) A strategy creates a build matrix for your jobs.

You can define different variations to run each job in.

builder

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

Returns:

a CommonJobDefinition.Builder of CommonJobDefinition