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.Defaults

Description

This module provides the Defaults type for setting default values that apply to all steps within a job or all jobs within a workflow.

Defaults allow you to specify common settings like shell type and working directory that will be inherited by all steps unless explicitly overridden at the step level.

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

Synopsis

Documentation

data Defaults Source #

Default settings for steps within a job or jobs within a workflow.

Defaults provide a convenient way to set common configuration that applies to both Jobs and Workflows without having to repeat the same settings everywhere.

Example usage:

import Language.Github.Actions.Defaults
import Language.Github.Actions.Shell

-- Set bash as default shell for all steps
bashDefaults :: Defaults
bashDefaults = Defaults
 { runShell = Just (Bash Nothing)
 , runWorkingDirectory = Nothing
 }

-- Set working directory for all steps
workdirDefaults :: Defaults
workdirDefaults = Defaults
 { runShell = Nothing
 , runWorkingDirectory = Just "/src"
 }

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

Constructors

Defaults 

Fields

Instances

Instances details
FromJSON Defaults Source # 
Instance details

Defined in Language.Github.Actions.Defaults

ToJSON Defaults Source # 
Instance details

Defined in Language.Github.Actions.Defaults

Generic Defaults Source # 
Instance details

Defined in Language.Github.Actions.Defaults

Associated Types

type Rep Defaults 
Instance details

Defined in Language.Github.Actions.Defaults

type Rep Defaults = D1 ('MetaData "Defaults" "Language.Github.Actions.Defaults" "github-actions-0.1.1.0-BjHhRMO6iQ17qdsNXwhDab" 'False) (C1 ('MetaCons "Defaults" 'PrefixI 'True) (S1 ('MetaSel ('Just "runShell") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Shell)) :*: S1 ('MetaSel ('Just "runWorkingDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

Methods

from :: Defaults -> Rep Defaults x #

to :: Rep Defaults x -> Defaults #

Show Defaults Source # 
Instance details

Defined in Language.Github.Actions.Defaults

Eq Defaults Source # 
Instance details

Defined in Language.Github.Actions.Defaults

Ord Defaults Source # 
Instance details

Defined in Language.Github.Actions.Defaults

type Rep Defaults Source # 
Instance details

Defined in Language.Github.Actions.Defaults

type Rep Defaults = D1 ('MetaData "Defaults" "Language.Github.Actions.Defaults" "github-actions-0.1.1.0-BjHhRMO6iQ17qdsNXwhDab" 'False) (C1 ('MetaCons "Defaults" 'PrefixI 'True) (S1 ('MetaSel ('Just "runShell") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Shell)) :*: S1 ('MetaSel ('Just "runWorkingDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))