Documentation

Environment configuration for deployment jobs.

Job environments can be specified in two ways:

• NamedJobEnvironment - Reference a named environment by string
• CustomJobEnvironment - Configure environment with custom URL and other properties

Named environments are the most common and reference environments configured in your repository settings. Custom environments allow inline configuration for specific deployment scenarios.

Example usage:

import Language.Github.Actions.Job.Environment
import qualified Data.Map as Map

-- Reference a named environment
prodEnvironment :: JobEnvironment
prodEnvironment = NamedJobEnvironment "production"

stagingEnvironment :: JobEnvironment
stagingEnvironment = NamedJobEnvironment "staging"

-- Custom environment with URL
customEnvironment :: JobEnvironment
customEnvironment = CustomJobEnvironment $ Map.fromList
 [ ("name", "review-pr-123")
 , ("url", "https://pr-123.preview.example.com")
 ]

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