github-actions-0.1.1.0: Github Actions
Copyright(c) 2025 Bellroy Pty Ltd
LicenseBSD-3-Clause
MaintainerBellroy Tech Team <haskell@bellroy.com>
Safe HaskellNone
LanguageHaskell2010

Language.Github.Actions.Job.Id

Description

This module provides the JobId type for uniquely identifying jobs within GitHub Actions workflows.

Job IDs are used to reference jobs in dependency declarations (needs), outputs, and other cross-job references. They must be unique within a workflow and follow specific naming conventions.

For more information about GitHub Actions job IDs, see: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_id

Synopsis

Documentation

newtype JobId Source #

A unique identifier for a job within a GitHub Actions workflow.

Job IDs are used to: * Reference jobs in dependency declarations (needs) * Access job outputs from other jobs * Identify jobs in workflow run logs and API responses

Job IDs must be unique within a workflow and should follow these conventions: * Start with a letter or underscore * Contain only alphanumeric characters, hyphens, and underscores * Be descriptive of the job's purpose

Example usage:

import Language.Github.Actions.Job.Id

-- Simple job IDs
buildJobId :: JobId
buildJobId = JobId "build"

testJobId :: JobId
testJobId = JobId "test"

-- More descriptive job IDs
deployProdJobId :: JobId
deployProdJobId = JobId "deploy-production"

For more details, see: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_id

Constructors

JobId Text 

Instances

Instances details
FromJSON JobId Source # 
Instance details

Defined in Language.Github.Actions.Job.Id

FromJSONKey JobId Source # 
Instance details

Defined in Language.Github.Actions.Job.Id

ToJSON JobId Source # 
Instance details

Defined in Language.Github.Actions.Job.Id

ToJSONKey JobId Source # 
Instance details

Defined in Language.Github.Actions.Job.Id

Generic JobId Source # 
Instance details

Defined in Language.Github.Actions.Job.Id

Associated Types

type Rep JobId 
Instance details

Defined in Language.Github.Actions.Job.Id

type Rep JobId = D1 ('MetaData "JobId" "Language.Github.Actions.Job.Id" "github-actions-0.1.1.0-BjHhRMO6iQ17qdsNXwhDab" 'True) (C1 ('MetaCons "JobId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: JobId -> Rep JobId x #

to :: Rep JobId x -> JobId #

Show JobId Source # 
Instance details

Defined in Language.Github.Actions.Job.Id

Methods

showsPrec :: Int -> JobId -> ShowS #

show :: JobId -> String #

showList :: [JobId] -> ShowS #

Eq JobId Source # 
Instance details

Defined in Language.Github.Actions.Job.Id

Methods

(==) :: JobId -> JobId -> Bool #

(/=) :: JobId -> JobId -> Bool #

Ord JobId Source # 
Instance details

Defined in Language.Github.Actions.Job.Id

Methods

compare :: JobId -> JobId -> Ordering #

(<) :: JobId -> JobId -> Bool #

(<=) :: JobId -> JobId -> Bool #

(>) :: JobId -> JobId -> Bool #

(>=) :: JobId -> JobId -> Bool #

max :: JobId -> JobId -> JobId #

min :: JobId -> JobId -> JobId #

type Rep JobId Source # 
Instance details

Defined in Language.Github.Actions.Job.Id

type Rep JobId = D1 ('MetaData "JobId" "Language.Github.Actions.Job.Id" "github-actions-0.1.1.0-BjHhRMO6iQ17qdsNXwhDab" 'True) (C1 ('MetaCons "JobId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))