Package io.typeflows.github.workflow
Class Job
-
- All Implemented Interfaces:
-
io.typeflows.util.Renderable
public final class Job extends Base implements Renderable<Map<String, Any>>
Represents a GitHub Actions workflow job.
A job is a set of steps that execute on the same runner. Jobs run in parallel by default but can be configured to run sequentially by defining dependencies. Each job runs in a fresh virtual environment specified by the runsOn parameter.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classJob.DSLpublic final classJob.Containerpublic classJob.Companion
-
Field Summary
Fields Modifier and Type Field Description public final static StrExpstatuspublic final static Job.Containercontainerpublic final Stringidpublic final RunsOnrunsOnpublic final Stringnamepublic final List<Job>needspublic final Strategystrategypublic final List<Output<?>>outputspublic final Expressionconditionpublic final Containercontainerpublic final Map<String, Object>envpublic final Defaultsdefaultspublic final List<Step>stepspublic final IntegertimeoutMinutespublic final BooleancontinueOnErrorpublic final Permissionspermissionspublic final static Job.CompanionCompanion
-
Method Summary
Modifier and Type Method Description Map<String, Object>render()final static Serviceservice(String name)final static Jobcreate(String id, RunsOn runsOn, Configure<Job.DSL> block)Creates and configures a Job instance. final static Jobcreate(String id, RunsOn runsOn)Creates and configures a Job instance. -
-
Method Detail
-
create
@JvmOverloads() final static Job create(String id, RunsOn runsOn, Configure<Job.DSL> block)
Creates and configures a Job instance.
- Parameters:
id- Unique identifier for the job (will be converted to lowercase with spaces replaced by hyphens)runsOn- The runner environment where the job will executeblock- Configuration lambda to set up the job- Returns:
Configured Job instance
-
create
@JvmOverloads() final static Job create(String id, RunsOn runsOn)
Creates and configures a Job instance.
- Parameters:
id- Unique identifier for the job (will be converted to lowercase with spaces replaced by hyphens)runsOn- The runner environment where the job will execute- Returns:
Configured Job instance
-
-
-
-