Safe Haskell	Safe-Inferred
Language	GHC2021

GitHub.Workflow.Command.Annotation

Contents

Annotations
Message
Properties
Output

Synopsis

debug :: Message -> Debug
newtype Debug = Debug {
- message :: Message
}
error :: Message -> Error
data Error = Error {
- message :: Message
- properties :: Properties
}
warning :: Message -> Warning
data Warning = Warning {
- message :: Message
- properties :: Properties
}
notice :: Message -> Notice
data Notice = Notice {
- message :: Message
- properties :: Properties
}
newtype Message = Message {
- text :: Text
}
class FromMessage a where
- fromMessage :: Message -> a
data Properties = Properties {
- title :: Maybe Text
- location :: Maybe Location
}
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
class Monad m => MonadCommand m where
- executeCommand :: ToCommand a => a -> m ()
class ToCommand a where
- addToCommand :: a -> Command -> Command
toCommand :: ToCommand a => a -> Command
class ToByteString a where
- toByteStringBuilder :: a -> Builder
- toByteString :: a -> ByteString
printByteStringLn :: (ToByteString a, MonadIO m) => a -> m ()

Annotations

Debug

debug :: Message -> Debug Source #

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 #

Error

error :: Message -> Error Source #

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 #

Warning

warning :: Message -> Warning Source #

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 #

Notice

notice :: Message -> Notice Source #

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 #

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 FromMessage a where Source #

Methods

fromMessage :: Message -> a Source #

Instances

Instances details

FromMessage Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods fromMessage :: Message -> Debug Source #
FromMessage Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods fromMessage :: Message -> Error Source #
FromMessage Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods fromMessage :: Message -> Notice Source #
FromMessage Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods fromMessage :: Message -> Warning Source #
FromMessage Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods fromMessage :: Message -> Message Source #

Properties

data Properties Source #

Constructors

Properties
Fields title :: Maybe Text A title for the annotation location :: Maybe Location

Instances

Instances details

HasLocationMaybe Properties Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Properties Methods location :: Lens' Properties (Maybe Location) Source #
GetProperties Properties Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Properties Methods getProperties :: Properties -> Properties Source #
HasProperties Properties Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Properties Methods annotationProperties :: Lens' Properties Properties Source #
AddToProperties Properties Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Properties Methods addToProperties :: Properties -> Properties0 -> Properties0 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 #

Output

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 #

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 #

toCommand :: ToCommand a => a -> Command Source #

class ToByteString a where Source #

Minimal complete definition

toByteStringBuilder

Methods

toByteStringBuilder :: a -> Builder Source #

toByteString :: a -> ByteString Source #

Instances

Instances details

ToByteString Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods toByteStringBuilder :: Debug -> Builder Source # toByteString :: Debug -> ByteString Source #
ToByteString Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods toByteStringBuilder :: Error -> Builder Source # toByteString :: Error -> ByteString Source #
ToByteString Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods toByteStringBuilder :: Notice -> Builder Source # toByteString :: Notice -> ByteString Source #
ToByteString Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods toByteStringBuilder :: Warning -> Builder Source # toByteString :: Warning -> ByteString Source #
ToByteString Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods toByteStringBuilder :: Command -> Builder Source # toByteString :: Command -> ByteString Source #
ToByteString Key Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Key Methods toByteStringBuilder :: Key -> Builder Source # toByteString :: Key -> ByteString Source #
ToByteString Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods toByteStringBuilder :: Message -> Builder Source # toByteString :: Message -> ByteString Source #
ToByteString Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods toByteStringBuilder :: Name -> Builder Source # toByteString :: Name -> ByteString Source #
ToByteString Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods toByteStringBuilder :: Properties -> Builder Source # toByteString :: Properties -> ByteString Source #
ToByteString Value Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Value Methods toByteStringBuilder :: Value -> Builder Source # toByteString :: Value -> ByteString Source #
ToCommand a => ToByteString (GenericAnnotation a) Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Generic Methods toByteStringBuilder :: GenericAnnotation a -> Builder Source # toByteString :: GenericAnnotation a -> ByteString Source #
ToCommand a => ToByteString (ByteStringViaCommand a) Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods toByteStringBuilder :: ByteStringViaCommand a -> Builder Source # toByteString :: ByteStringViaCommand a -> ByteString Source #

printByteStringLn :: (ToByteString a, MonadIO m) => a -> m () Source #