GitHub.Workflow.Command.Syntax.Command

Documentation

data Command

A GitHub workflow command

A Command consists of:

• Name (HasName)
• Message (HasMessage)
• Properties (HasProperties)

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

IsString Command

Defined in GitHub.Workflow.Command.Syntax.Command

Methods

fromString :: String -> Command

Show Command

Defined in GitHub.Workflow.Command.Syntax.Command

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

Eq Command

Defined in GitHub.Workflow.Command.Syntax.Command

Methods

(==) :: Command -> Command -> Bool

(/=) :: Command -> Command -> Bool

Ord Command

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

Defined in GitHub.Workflow.Command.Syntax.Command

Methods

message :: Lens' Command Message

HasName Command

Defined in GitHub.Workflow.Command.Syntax.Command

Methods

name :: Lens' Command Name

HasProperties Command

Defined in GitHub.Workflow.Command.Syntax.Command

Methods

properties :: Lens' Command Properties

ToByteString Command

Defined in GitHub.Workflow.Command.Syntax.Command

Methods

toByteStringBuilder :: Command -> Builder

toByteString :: Command -> ByteString

command :: Name -> Command

Construct a minimal command with a command Name e.g. "warning" or "error"

See the property and message lenses for other information include in a command.

class ToCommand a where

Methods

addToCommand :: a -> Command -> Command

Instances

ToCommand Debug

Defined in GitHub.Workflow.Command.Annotation.Commands.Debug

Methods

addToCommand :: Debug -> Command -> Command

ToCommand Error

Defined in GitHub.Workflow.Command.Annotation.Commands.Error

Methods

addToCommand :: Error -> Command -> Command

ToCommand Notice

Defined in GitHub.Workflow.Command.Annotation.Commands.Notice

Methods

addToCommand :: Notice -> Command -> Command

ToCommand Warning

Defined in GitHub.Workflow.Command.Annotation.Commands.Warning

Methods

addToCommand :: Warning -> Command -> Command

ToCommand GroupEnd

Defined in GitHub.Workflow.Command.Grouping

Methods

addToCommand :: GroupEnd -> Command -> Command

ToCommand GroupStart

Defined in GitHub.Workflow.Command.Grouping

Methods

addToCommand :: GroupStart -> Command -> Command

ToCommand AddMask

Defined in GitHub.Workflow.Command.Masking

Methods

addToCommand :: AddMask -> Command -> Command

ToCommand ResumeCommands

Defined in GitHub.Workflow.Command.Stopping

Methods

addToCommand :: ResumeCommands -> Command -> Command

ToCommand StopCommands

Defined in GitHub.Workflow.Command.Stopping

Methods

addToCommand :: StopCommands -> Command -> Command

(IsAnnotationType a, HasMessage a, GetProperties a) => ToCommand (GenericAnnotation a)

Defined in GitHub.Workflow.Command.Annotation.Commands.Generic

Methods

addToCommand :: GenericAnnotation a -> Command -> Command

toCommand :: ToCommand a => a -> Command

newtype ByteStringViaCommand a

Constructors

ByteStringViaCommand a

Instances

ToCommand a => ToByteString (ByteStringViaCommand a)

Defined in GitHub.Workflow.Command.Syntax.Command

Methods

toByteStringBuilder :: ByteStringViaCommand a -> Builder

toByteString :: ByteStringViaCommand a -> ByteString