github-workflow-commands-0.0.1.0: GitHub Actions workflow commands
Safe HaskellSafe-Inferred
LanguageGHC2021

GitHub.Workflow.Command.Syntax.Command

Synopsis

Documentation

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

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

HasMessage Command Source # 
Instance details

Defined in GitHub.Workflow.Command.Syntax.Command

HasName Command Source # 
Instance details

Defined in GitHub.Workflow.Command.Syntax.Command

HasProperties Command Source # 
Instance details

Defined in GitHub.Workflow.Command.Syntax.Command

ToByteString Command Source # 
Instance details

Defined in GitHub.Workflow.Command.Syntax.Command

command :: Name -> Command Source #

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 Source #

Methods

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

Instances

Instances details
ToCommand Debug Source # 
Instance details

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

ToCommand Error Source # 
Instance details

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

ToCommand Notice Source # 
Instance details

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

ToCommand Warning Source # 
Instance details

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

ToCommand GroupEnd Source # 
Instance details

Defined in GitHub.Workflow.Command.Grouping

ToCommand GroupStart Source # 
Instance details

Defined in GitHub.Workflow.Command.Grouping

ToCommand AddMask Source # 
Instance details

Defined in GitHub.Workflow.Command.Masking

ToCommand ResumeCommands Source # 
Instance details

Defined in GitHub.Workflow.Command.Stopping

ToCommand StopCommands Source # 
Instance details

Defined in GitHub.Workflow.Command.Stopping

(IsAnnotationType a, HasMessage a, GetProperties a) => ToCommand (GenericAnnotation a) Source # 
Instance details

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