github-actions-0.1.1.0: Github Actions

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

Description

This module provides the UnstructuredMap type for representing a map of values that can be strings, numbers, or booleans in GitHub Actions YAML files.

GitHub Actions allows flexible typing in many contexts: * retention-days: 1 (number) * retention-days: "1" (string) * should-retain: false (boolean)

This type preserves the original YAML type during round-trip parsing, ensuring that numeric values remain numeric and strings remain strings.

Synopsis

data UnstructuredValue
newtype UnstructuredMap = UnstructuredMap (Map Text UnstructuredValue)
renderUnstructuredValue :: UnstructuredValue -> Text
gen :: MonadGen m => m UnstructuredMap

Documentation

data UnstructuredValue Source #

A map that can have values of string, number, or boolean.

This type is designed to handle the flexible typing that GitHub Actions allows in YAML files.

The type preserves the original format during round-trip serialization, so numeric inputs remain numeric in the output YAML.

Constructors

UnstructuredValueString Text
UnstructuredValueNumber Double
UnstructuredValueBool Bool

Instances

Instances details

FromJSON UnstructuredValue Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

Methods

parseJSON :: Value -> Parser UnstructuredValue #

parseJSONList :: Value -> Parser [UnstructuredValue] #

omittedField :: Maybe UnstructuredValue #

ToJSON UnstructuredValue Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

Methods

toJSON :: UnstructuredValue -> Value #

toEncoding :: UnstructuredValue -> Encoding #

toJSONList :: [UnstructuredValue] -> Value #

toEncodingList :: [UnstructuredValue] -> Encoding #

omitField :: UnstructuredValue -> Bool #

Generic UnstructuredValue Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

Associated Types

type Rep UnstructuredValue

Instance details

Defined in Language.Github.Actions.UnstructuredMap

type Rep UnstructuredValue = D1 ('MetaData "UnstructuredValue" "Language.Github.Actions.UnstructuredMap" "github-actions-0.1.1.0-BjHhRMO6iQ17qdsNXwhDab" 'False) (C1 ('MetaCons "UnstructuredValueString" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "UnstructuredValueNumber" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :+: C1 ('MetaCons "UnstructuredValueBool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

Methods

from :: UnstructuredValue -> Rep UnstructuredValue x #

to :: Rep UnstructuredValue x -> UnstructuredValue #

Show UnstructuredValue Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

Methods

showsPrec :: Int -> UnstructuredValue -> ShowS #

show :: UnstructuredValue -> String #

showList :: [UnstructuredValue] -> ShowS #

Eq UnstructuredValue Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

Methods

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

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

Ord UnstructuredValue Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

Methods

compare :: UnstructuredValue -> UnstructuredValue -> Ordering #

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

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

(>) :: UnstructuredValue -> UnstructuredValue -> Bool #

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

max :: UnstructuredValue -> UnstructuredValue -> UnstructuredValue #

min :: UnstructuredValue -> UnstructuredValue -> UnstructuredValue #

type Rep UnstructuredValue Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

type Rep UnstructuredValue = D1 ('MetaData "UnstructuredValue" "Language.Github.Actions.UnstructuredMap" "github-actions-0.1.1.0-BjHhRMO6iQ17qdsNXwhDab" 'False) (C1 ('MetaCons "UnstructuredValueString" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "UnstructuredValueNumber" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :+: C1 ('MetaCons "UnstructuredValueBool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

newtype UnstructuredMap Source #

Constructors

UnstructuredMap (Map Text UnstructuredValue)

Instances

Instances details

FromJSON UnstructuredMap Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

Methods

parseJSON :: Value -> Parser UnstructuredMap #

parseJSONList :: Value -> Parser [UnstructuredMap] #

omittedField :: Maybe UnstructuredMap #

ToJSON UnstructuredMap Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

Methods

toJSON :: UnstructuredMap -> Value #

toEncoding :: UnstructuredMap -> Encoding #

toJSONList :: [UnstructuredMap] -> Value #

toEncodingList :: [UnstructuredMap] -> Encoding #

omitField :: UnstructuredMap -> Bool #

Generic UnstructuredMap Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

Associated Types

type Rep UnstructuredMap

Instance details

Defined in Language.Github.Actions.UnstructuredMap

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

Methods

from :: UnstructuredMap -> Rep UnstructuredMap x #

to :: Rep UnstructuredMap x -> UnstructuredMap #

Show UnstructuredMap Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

Methods

showsPrec :: Int -> UnstructuredMap -> ShowS #

show :: UnstructuredMap -> String #

showList :: [UnstructuredMap] -> ShowS #

Eq UnstructuredMap Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

Methods

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

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

Ord UnstructuredMap Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

Methods

compare :: UnstructuredMap -> UnstructuredMap -> Ordering #

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

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

(>) :: UnstructuredMap -> UnstructuredMap -> Bool #

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

max :: UnstructuredMap -> UnstructuredMap -> UnstructuredMap #

min :: UnstructuredMap -> UnstructuredMap -> UnstructuredMap #

type Rep UnstructuredMap Source #

Instance details

Defined in Language.Github.Actions.UnstructuredMap

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

renderUnstructuredValue :: UnstructuredValue -> Text Source #

gen :: MonadGen m => m UnstructuredMap Source #