| Copyright | (c) 2025 Bellroy Pty Ltd |
|---|---|
| License | BSD-3-Clause |
| Maintainer | Bellroy Tech Team <haskell@bellroy.com> |
| Safe Haskell | None |
| Language | Haskell2010 |
Language.Github.Actions.Job
Description
This module provides the Job type for representing individual jobs within GitHub Actions workflows.
Jobs are collections of steps that execute on the same runner.
A job defines the environment, dependencies, and steps that should be executed as part of a workflow. Jobs can run in parallel or be configured to depend on other jobs.
For more information about GitHub Actions job syntax, see: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobs
Synopsis
- data Job = Job {
- concurrency :: Maybe Concurrency
- container :: Maybe JobContainer
- continueOnError :: Maybe Bool
- defaults :: Maybe Defaults
- env :: Map Text Text
- environment :: Maybe JobEnvironment
- jobName :: Maybe Text
- needs :: Maybe JobNeeds
- outputs :: Map Text Text
- permissions :: Maybe Permissions
- runIf :: Maybe RunIf
- runsOn :: Maybe Text
- secrets :: Map Text Text
- services :: Map ServiceId Service
- steps :: Maybe (NonEmpty Step)
- strategy :: Maybe JobStrategy
- timeoutMinutes :: Maybe Int
- uses :: Maybe Text
- with :: Map Text Text
- gen :: MonadGen m => m Job
- new :: Job
Documentation
A job within a GitHub Actions workflow.
A job is a set of steps that execute on the same runner. Jobs can run in parallel or sequentially depending on their dependencies. Each job runs in its own virtual environment specified by the runner.
Example usage:
import Language.Github.Actions.Job
import qualified Language.Github.Actions.Step as Step
myJob :: Job
myJob = new
{ jobName = Just "Build and Test"
, runsOn = Just "ubuntu-latest"
, steps = Just $ Step.new :| []
}
For more details, see: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobs
Constructors
| Job | |
Fields
| |