Safe Haskell	Safe-Inferred
Language	GHC2021

GitHub.Workflow.Command

Contents

Executing commands
Commands
Location
- File
- Position
Anatomy of a command

Description

Programs run by GitHub Actions can use workflow commands to communicate with the runner.

GitHub documentation: Workflow commands for GitHub Actions

Synopsis

class Monad m => MonadCommand m where
- executeCommand :: ToCommand a => a -> m ()
newtype PrintCommands m a = PrintCommands (m a)
class ToCommand a where
- addToCommand :: a -> Command -> Command
newtype Debug = Debug {
- message :: Message
}
debug :: Message -> Debug
data Notice = Notice {
- message :: Message
- properties :: Properties
}
notice :: Message -> Notice
data Warning = Warning {
- message :: Message
- properties :: Properties
}
warning :: Message -> Warning
data Error = Error {
- message :: Message
- properties :: Properties
}
error :: Message -> Error
group :: MonadCommand m => Text -> m a -> m a
newtype GroupStart = GroupStart {
- title :: Text
}
data GroupEnd = GroupEnd
newtype AddMask = AddMask {
- value :: Text
}
suspendCommands :: (MonadCommand m, MonadRandom m) => m a -> m a
stopCommands :: (MonadCommand m, MonadRandom m) => m SuspendToken
resumeCommands :: MonadCommand m => SuspendToken -> m ()
data SuspendToken
data Location = Location {
- file :: File
- position :: Maybe Position
}
class HasLocationMaybe a where
- location :: Lens' a (Maybe Location)
newtype File = File {
- text :: Text
}
inFile :: File -> Location
file :: Lens' Location File
data Position = Position {
- line :: Line
- extent :: Maybe Extent
}
position :: Lens' Location (Maybe Position)
data Extent
- = WithinLine Columns
- | ToLine Line
extent :: Lens' Position (Maybe Extent)
data Columns = Columns {
- start :: Column
- end :: Maybe Column
}
line :: Lens' Position Line
startColumn :: Lens' Columns Column
endColumn :: Lens' Columns (Maybe Column)
newtype Line = Line {
- natural :: Natural
}
atLine :: Line -> Position
newtype Column = Column {
- natural :: Natural
}
atColumn :: Column -> Columns
data Command
newtype Name = Name {
- text :: Text
}
class HasName a where
- name :: Lens' a Name
newtype Message = Message {
- text :: Text
}
class HasMessage a where
- message :: Lens' a Message
data Properties
class HasProperties a where
- properties :: Lens' a Properties
newtype Key = Key {
- text :: Text
}
newtype Value = Value {
- text :: Text
}

Executing commands

class Monad m => MonadCommand m where Source #

Monadic context in which GitHub workflow commands may be executed

For the most basic uses, use the IO instance, which prints commands to stdout.
For custom monads that support MonadIO, you may derive MonadCommand via PrintCommands to get the same behavior that IO exhibits.
A program that wishes to accommodate running in both GitHub and non-GitHub contexts may wish to define a more sophisicated MonadCommand instance that prints GitHub workflow commands only when the GITHUB_ACTIONS environment variable is present, and otherwise takes some other more context-appropriate action.

Methods

executeCommand :: ToCommand a => a -> m () Source #

Instances

Instances details

MonadCommand IO Source #
Instance details Defined in GitHub.Workflow.Command.Execution Methods executeCommand :: ToCommand a => a -> IO () Source #
MonadIO m => MonadCommand (PrintCommands m) Source #
Instance details Defined in GitHub.Workflow.Command.Execution Methods executeCommand :: ToCommand a => a -> PrintCommands m () Source #

newtype PrintCommands m a Source #

Constructors

PrintCommands (m a)

Instances

Instances details

MonadIO m => MonadIO (PrintCommands m) Source #
Instance details Defined in GitHub.Workflow.Command.Execution Methods liftIO :: IO a -> PrintCommands m a #
Applicative m => Applicative (PrintCommands m) Source #
Instance details Defined in GitHub.Workflow.Command.Execution Methods pure :: a -> PrintCommands m a # (<>) :: PrintCommands m (a -> b) -> PrintCommands m a -> PrintCommands m b # liftA2 :: (a -> b -> c) -> PrintCommands m a -> PrintCommands m b -> PrintCommands m c # (>) :: PrintCommands m a -> PrintCommands m b -> PrintCommands m b # (<*) :: PrintCommands m a -> PrintCommands m b -> PrintCommands m a #
Functor m => Functor (PrintCommands m) Source #
Instance details Defined in GitHub.Workflow.Command.Execution Methods fmap :: (a -> b) -> PrintCommands m a -> PrintCommands m b # (<$) :: a -> PrintCommands m b -> PrintCommands m a #
Monad m => Monad (PrintCommands m) Source #
Instance details Defined in GitHub.Workflow.Command.Execution Methods (>>=) :: PrintCommands m a -> (a -> PrintCommands m b) -> PrintCommands m b # (>>) :: PrintCommands m a -> PrintCommands m b -> PrintCommands m b # return :: a -> PrintCommands m a #
MonadIO m => MonadCommand (PrintCommands m) Source #
Instance details Defined in GitHub.Workflow.Command.Execution Methods executeCommand :: ToCommand a => a -> PrintCommands m () Source #

Commands

class ToCommand a where Source #

Methods

addToCommand :: a -> Command -> Command Source #

Instances

Instances details

ToCommand Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods addToCommand :: Debug -> Command -> Command Source #
ToCommand Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods addToCommand :: Error -> Command -> Command Source #
ToCommand Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods addToCommand :: Notice -> Command -> Command Source #
ToCommand Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods addToCommand :: Warning -> Command -> Command Source #
ToCommand GroupEnd Source #
Instance details Defined in GitHub.Workflow.Command.Grouping Methods addToCommand :: GroupEnd -> Command -> Command Source #
ToCommand GroupStart Source #
Instance details Defined in GitHub.Workflow.Command.Grouping Methods addToCommand :: GroupStart -> Command -> Command Source #
ToCommand AddMask Source #
Instance details Defined in GitHub.Workflow.Command.Masking Methods addToCommand :: AddMask -> Command -> Command Source #
ToCommand ResumeCommands Source #
Instance details Defined in GitHub.Workflow.Command.Stopping Methods addToCommand :: ResumeCommands -> Command -> Command Source #
ToCommand StopCommands Source #
Instance details Defined in GitHub.Workflow.Command.Stopping Methods addToCommand :: StopCommands -> Command -> Command Source #
(IsAnnotationType a, HasMessage a, GetProperties a) => ToCommand (GenericAnnotation a) Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Generic Methods addToCommand :: GenericAnnotation a -> Command -> Command Source #

Setting a debug message

newtype Debug Source #

Prints a debug message to the log

GitHub documentation: Setting a debug message

Constructors

Debug
Fields message :: Message

Instances

Instances details

GetProperties Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods getProperties :: Debug -> Properties Source #
ToCommand Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods addToCommand :: Debug -> Command -> Command Source #
FromMessage Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods fromMessage :: Message -> Debug Source #
HasMessage Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods message :: Lens' Debug Message Source #
ToByteString Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods toByteStringBuilder :: Debug -> Builder Source # toByteString :: Debug -> ByteString Source #
IsAnnotationType Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods annotationTypeName :: Name Source #

debug :: Message -> Debug Source #

Setting a notice message

data Notice Source #

Creates a notice message and prints the message to the log

The message can be associated with a particular file in your repository, and optionally also a position within the file. See HasLocationMaybe.

GitHub documentation: Setting a notice message

Constructors

Notice
Fields message :: Message properties :: Properties

Instances

Instances details

HasLocationMaybe Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods location :: Lens' Notice (Maybe Location) Source #
GetProperties Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods getProperties :: Notice -> Properties Source #
HasProperties Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods annotationProperties :: Lens' Notice Properties Source #
ToCommand Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods addToCommand :: Notice -> Command -> Command Source #
FromMessage Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods fromMessage :: Message -> Notice Source #
HasMessage Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods message :: Lens' Notice Message Source #
ToByteString Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods toByteStringBuilder :: Notice -> Builder Source # toByteString :: Notice -> ByteString Source #
IsAnnotationType Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods annotationTypeName :: Name Source #

notice :: Message -> Notice Source #

Setting a warning message

data Warning Source #

Creates a warning message and prints the message to the log

The message can be associated with a particular file in your repository, and optionally also a position within the file. See HasLocationMaybe.

GitHub documentation: Setting a warning message

Constructors

Warning
Fields message :: Message properties :: Properties

Instances

Instances details

HasLocationMaybe Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods location :: Lens' Warning (Maybe Location) Source #
GetProperties Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods getProperties :: Warning -> Properties Source #
HasProperties Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods annotationProperties :: Lens' Warning Properties Source #
ToCommand Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods addToCommand :: Warning -> Command -> Command Source #
FromMessage Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods fromMessage :: Message -> Warning Source #
HasMessage Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods message :: Lens' Warning Message Source #
ToByteString Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods toByteStringBuilder :: Warning -> Builder Source # toByteString :: Warning -> ByteString Source #
IsAnnotationType Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods annotationTypeName :: Name Source #

warning :: Message -> Warning Source #

Setting an error message

data Error Source #

Creates an error message and prints the message to the log

The message can be associated with a particular file in your repository, and optionally also a position within the file. See HasLocationMaybe.

GitHub documentation: Setting an error message

Constructors

Error
Fields message :: Message properties :: Properties

Instances

Instances details

HasLocationMaybe Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods location :: Lens' Error (Maybe Location) Source #
GetProperties Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods getProperties :: Error -> Properties Source #
HasProperties Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods annotationProperties :: Lens' Error Properties Source #
ToCommand Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods addToCommand :: Error -> Command -> Command Source #
FromMessage Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods fromMessage :: Message -> Error Source #
HasMessage Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods message :: Lens' Error Message Source #
ToByteString Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods toByteStringBuilder :: Error -> Builder Source # toByteString :: Error -> ByteString Source #
IsAnnotationType Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods annotationTypeName :: Name Source #

error :: Message -> Error Source #

Grouping log lines

group Source #

Arguments

:: MonadCommand m
=> Text	Group title
-> m a	Anything printed within this action will be nested inside an expandable entry in the log
-> m a

Creates an expandable group in the log

GitHub documentation: Grouping log lines

newtype GroupStart Source #

Starts a group

Constructors

GroupStart
Fields title :: Text

Instances

Instances details

ToCommand GroupStart Source #
Instance details Defined in GitHub.Workflow.Command.Grouping Methods addToCommand :: GroupStart -> Command -> Command Source #

data GroupEnd Source #

Ends a group

Constructors

GroupEnd

Instances

Instances details

ToCommand GroupEnd Source #
Instance details Defined in GitHub.Workflow.Command.Grouping Methods addToCommand :: GroupEnd -> Command -> Command Source #

Masking a value in a log

newtype AddMask Source #

Prevents a string or variable from being printed in the log

GitHub documentation: Masking a value in a log

Constructors

AddMask
Fields value :: Text An environment variable or string

Instances

Instances details

ToCommand AddMask Source #
Instance details Defined in GitHub.Workflow.Command.Masking Methods addToCommand :: AddMask -> Command -> Command Source #

Stopping and starting workflow commands

suspendCommands Source #

Arguments

:: (MonadCommand m, MonadRandom m)
=> m a	Commands issued by this action will have no effect
-> m a

Run an action with processing of workflow commands suspended

GitHub documentation: Stopping and starting workflow commands

stopCommands :: (MonadCommand m, MonadRandom m) => m SuspendToken Source #

Stops processing any workflow commands

This special command allows you to log anything without accidentally running a workflow command.

resumeCommands :: MonadCommand m => SuspendToken -> m () Source #

Resume processing workflow commands

data SuspendToken Source #

Location

data Location Source #

Constructors

Location
Fields file :: File The path of the file for which the annotation should be created position :: Maybe Position

Instances

Instances details

IsString Location Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Location Methods fromString :: String -> Location #
AddToProperties Location Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Location Methods addToProperties :: Location -> Properties -> Properties Source #
HasLocationMaybe (Maybe Location) Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Location Methods location :: Lens' (Maybe Location) (Maybe Location) Source #

class HasLocationMaybe a where Source #

Methods

location :: Lens' a (Maybe Location) Source #

Instances

Instances details

HasLocationMaybe Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods location :: Lens' Error (Maybe Location) Source #
HasLocationMaybe Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods location :: Lens' Notice (Maybe Location) Source #
HasLocationMaybe Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods location :: Lens' Warning (Maybe Location) Source #
HasLocationMaybe Properties Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Properties Methods location :: Lens' Properties (Maybe Location) Source #
HasProperties a => HasLocationMaybe (GenericAnnotation a) Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Generic Methods location :: Lens' (GenericAnnotation a) (Maybe Location) Source #
HasLocationMaybe (Maybe Location) Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Location Methods location :: Lens' (Maybe Location) (Maybe Location) Source #

File

newtype File Source #

Constructors

File
Fields text :: Text

Instances

Instances details

IsString File Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.File Methods fromString :: String -> File #
Show File Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.File Methods showsPrec :: Int -> File -> ShowS # show :: File -> String # showList :: [File] -> ShowS #
Eq File Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.File Methods (==) :: File -> File -> Bool # (/=) :: File -> File -> Bool #
Ord File Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.File Methods compare :: File -> File -> Ordering # (<) :: File -> File -> Bool # (<=) :: File -> File -> Bool # (>) :: File -> File -> Bool # (>=) :: File -> File -> Bool # max :: File -> File -> File # min :: File -> File -> File #

inFile :: File -> Location Source #

file :: Lens' Location File Source #

Position

data Position Source #

Where an annotation is marked within a file

Constructors

Position
Fields line :: Line extent :: Maybe Extent

Instances

Instances details

AddToProperties Position Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position Methods addToProperties :: Position -> Properties -> Properties Source #

position :: Lens' Location (Maybe Position) Source #

data Extent Source #

Extra positional data, as a modification to the start Line

Constructors

WithinLine Columns
ToLine Line

Instances

Instances details

AddToProperties Extent Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position.Extent Methods addToProperties :: Extent -> Properties -> Properties Source #

extent :: Lens' Position (Maybe Extent) Source #

data Columns Source #

Constructors

Columns
Fields start :: Column end :: Maybe Column

Instances

Instances details

AddToProperties Columns Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position.Columns Methods addToProperties :: Columns -> Properties -> Properties Source #

line :: Lens' Position Line Source #

startColumn :: Lens' Columns Column Source #

endColumn :: Lens' Columns (Maybe Column) Source #

newtype Line Source #

Constructors

Line
Fields natural :: Natural

Instances

Instances details

Num Line Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position.Line Methods (+) :: Line -> Line -> Line # (-) :: Line -> Line -> Line # (*) :: Line -> Line -> Line # negate :: Line -> Line # abs :: Line -> Line # signum :: Line -> Line # fromInteger :: Integer -> Line #
Show Line Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position.Line Methods showsPrec :: Int -> Line -> ShowS # show :: Line -> String # showList :: [Line] -> ShowS #
Eq Line Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position.Line Methods (==) :: Line -> Line -> Bool # (/=) :: Line -> Line -> Bool #
Ord Line Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position.Line Methods compare :: Line -> Line -> Ordering # (<) :: Line -> Line -> Bool # (<=) :: Line -> Line -> Bool # (>) :: Line -> Line -> Bool # (>=) :: Line -> Line -> Bool # max :: Line -> Line -> Line # min :: Line -> Line -> Line #

atLine :: Line -> Position Source #

newtype Column Source #

Constructors

Column
Fields natural :: Natural

Instances

Instances details

Num Column Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position.Column Methods (+) :: Column -> Column -> Column # (-) :: Column -> Column -> Column # (*) :: Column -> Column -> Column # negate :: Column -> Column # abs :: Column -> Column # signum :: Column -> Column # fromInteger :: Integer -> Column #
Show Column Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position.Column Methods showsPrec :: Int -> Column -> ShowS # show :: Column -> String # showList :: [Column] -> ShowS #
Eq Column Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position.Column Methods (==) :: Column -> Column -> Bool # (/=) :: Column -> Column -> Bool #
Ord Column Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position.Column Methods compare :: Column -> Column -> Ordering # (<) :: Column -> Column -> Bool # (<=) :: Column -> Column -> Bool # (>) :: Column -> Column -> Bool # (>=) :: Column -> Column -> Bool # max :: Column -> Column -> Column # min :: Column -> Column -> Column #

atColumn :: Column -> Columns Source #

Anatomy of a command

data Command Source #

A GitHub workflow command

A Command consists of:

Of these, only Name is always required. Some particular types of command require a message or have restrictions on what properties they support or require.

Instances

Instances details

IsString Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods fromString :: String -> Command #
Show Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods showsPrec :: Int -> Command -> ShowS # show :: Command -> String # showList :: [Command] -> ShowS #
Eq Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods (==) :: Command -> Command -> Bool # (/=) :: Command -> Command -> Bool #
Ord Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods compare :: Command -> Command -> Ordering # (<) :: Command -> Command -> Bool # (<=) :: Command -> Command -> Bool # (>) :: Command -> Command -> Bool # (>=) :: Command -> Command -> Bool # max :: Command -> Command -> Command # min :: Command -> Command -> Command #
HasMessage Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods message :: Lens' Command Message Source #
HasName Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods name :: Lens' Command Name Source #
HasProperties Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods properties :: Lens' Command Properties Source #
ToByteString Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods toByteStringBuilder :: Command -> Builder Source # toByteString :: Command -> ByteString Source #

Name

newtype Name Source #

Constructors

Name
Fields text :: Text

Instances

Instances details

IsString Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods fromString :: String -> Name #
Show Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #
Eq Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Ord Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods compare :: Name -> Name -> Ordering # (<) :: Name -> Name -> Bool # (<=) :: Name -> Name -> Bool # (>) :: Name -> Name -> Bool # (>=) :: Name -> Name -> Bool # max :: Name -> Name -> Name # min :: Name -> Name -> Name #
HasName Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods name :: Lens' Name Name Source #
ToByteString Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods toByteStringBuilder :: Name -> Builder Source # toByteString :: Name -> ByteString Source #

class HasName a where Source #

Methods

name :: Lens' a Name Source #

Instances

Instances details

HasName Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods name :: Lens' Command Name Source #
HasName Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods name :: Lens' Name Name Source #

Message

newtype Message Source #

Constructors

Message
Fields text :: Text

Instances

Instances details

IsString Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods fromString :: String -> Message #
Show Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Eq Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Ord Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods compare :: Message -> Message -> Ordering # (<) :: Message -> Message -> Bool # (<=) :: Message -> Message -> Bool # (>) :: Message -> Message -> Bool # (>=) :: Message -> Message -> Bool # max :: Message -> Message -> Message # min :: Message -> Message -> Message #
FromMessage Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods fromMessage :: Message -> Message Source #
HasMessage Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods message :: Lens' Message Message Source #
ToByteString Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods toByteStringBuilder :: Message -> Builder Source # toByteString :: Message -> ByteString Source #

class HasMessage a where Source #

Methods

message :: Lens' a Message Source #

Instances

Instances details

HasMessage Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods message :: Lens' Debug Message Source #
HasMessage Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods message :: Lens' Error Message Source #
HasMessage Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods message :: Lens' Notice Message Source #
HasMessage Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods message :: Lens' Warning Message Source #
HasMessage Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods message :: Lens' Command Message Source #
HasMessage Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods message :: Lens' Message Message Source #

Properties

data Properties Source #

Instances

Instances details

Show Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods showsPrec :: Int -> Properties -> ShowS # show :: Properties -> String # showList :: [Properties] -> ShowS #
Eq Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods (==) :: Properties -> Properties -> Bool # (/=) :: Properties -> Properties -> Bool #
Ord Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods compare :: Properties -> Properties -> Ordering # (<) :: Properties -> Properties -> Bool # (<=) :: Properties -> Properties -> Bool # (>) :: Properties -> Properties -> Bool # (>=) :: Properties -> Properties -> Bool # max :: Properties -> Properties -> Properties # min :: Properties -> Properties -> Properties #
HasProperties Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods properties :: Lens' Properties Properties Source #
ToByteString Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods toByteStringBuilder :: Properties -> Builder Source # toByteString :: Properties -> ByteString Source #

class HasProperties a where Source #

Methods

properties :: Lens' a Properties Source #

Instances

Instances details

HasProperties Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods properties :: Lens' Command Properties Source #
HasProperties Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods properties :: Lens' Properties Properties Source #

newtype Key Source #

Constructors

Key
Fields text :: Text

Instances

Instances details

IsString Key Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Key Methods fromString :: String -> Key #
Show Key Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Key Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #
Eq Key Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Key Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Ord Key Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Key Methods compare :: Key -> Key -> Ordering # (<) :: Key -> Key -> Bool # (<=) :: Key -> Key -> Bool # (>) :: Key -> Key -> Bool # (>=) :: Key -> Key -> Bool # max :: Key -> Key -> Key # min :: Key -> Key -> Key #
ToByteString Key Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Key Methods toByteStringBuilder :: Key -> Builder Source # toByteString :: Key -> ByteString Source #

newtype Value Source #

Constructors

Value
Fields text :: Text

Instances

Instances details

IsString Value Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Value Methods fromString :: String -> Value #
Show Value Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Value Methods showsPrec :: Int -> Value -> ShowS # show :: Value -> String # showList :: [Value] -> ShowS #
Eq Value Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Value Methods (==) :: Value -> Value -> Bool # (/=) :: Value -> Value -> Bool #
Ord Value Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Value Methods compare :: Value -> Value -> Ordering # (<) :: Value -> Value -> Bool # (<=) :: Value -> Value -> Bool # (>) :: Value -> Value -> Bool # (>=) :: Value -> Value -> Bool # max :: Value -> Value -> Value # min :: Value -> Value -> Value #
ToByteString Value Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Value Methods toByteStringBuilder :: Value -> Builder Source # toByteString :: Value -> ByteString Source #