| 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.Step.Id
Description
This module provides the StepId type for uniquely identifying steps within
GitHub Actions jobs.
Step IDs are used to reference step outputs from later steps in the same job or from other jobs. They must be unique within a job and follow specific naming conventions.
For more information about GitHub Actions step IDs, see: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsid
Documentation
A unique identifier for a step within a GitHub Actions job.
Step IDs are used to:
* Reference step outputs from later steps using steps.step_id.outputs.output_name
* Reference step outcomes using steps.step_id.outcome or steps.step_id.conclusion
* Create dependencies between steps (though steps run sequentially by default)
Step IDs must be unique within a job and should follow these conventions: * Start with a letter or underscore * Contain only alphanumeric characters, hyphens, and underscores * Be descriptive of the step's purpose
Example usage:
import Language.Github.Actions.Step.Id -- Simple step IDs checkoutStepId :: StepId checkoutStepId = StepId "checkout" buildStepId :: StepId buildStepId = StepId "build" -- More descriptive step IDs uploadArtifactsStepId :: StepId uploadArtifactsStepId = StepId "upload-build-artifacts"
For more details, see: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsid
Instances
| FromJSON StepId Source # | |||||
Defined in Language.Github.Actions.Step.Id | |||||
| FromJSONKey StepId Source # | |||||
Defined in Language.Github.Actions.Step.Id | |||||
| ToJSON StepId Source # | |||||
| ToJSONKey StepId Source # | |||||
Defined in Language.Github.Actions.Step.Id | |||||
| Generic StepId Source # | |||||
Defined in Language.Github.Actions.Step.Id Associated Types
| |||||
| Show StepId Source # | |||||
| Eq StepId Source # | |||||
| Ord StepId Source # | |||||
| type Rep StepId Source # | |||||
Defined in Language.Github.Actions.Step.Id | |||||