github-workflow-commands-0.0.1.0: library/GitHub/Workflow/Command.hs

-- | Programs run by GitHub Actions can use workflow commands to communicate with the runner.
--
-- GitHub documentation:
-- <https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions Workflow commands for GitHub Actions>
module GitHub.Workflow.Command
  ( -- * Executing commands
    MonadCommand (..)
  , PrintCommands (..)

    -- * Commands
  , ToCommand (..)

    -- ** Setting a debug message
  , Debug (..)
  , debug

    -- ** Setting a notice message
  , Notice (..)
  , notice

    -- ** Setting a warning message
  , Warning (..)
  , warning

    -- ** Setting an error message
  , Error (..)
  , error

    -- ** Grouping log lines
  , group
  , GroupStart (..)
  , GroupEnd (..)

    -- ** Masking a value in a log
  , AddMask (..)

    -- ** Stopping and starting workflow commands
  , suspendCommands
  , stopCommands
  , resumeCommands
  , SuspendToken

    -- * Location
  , Location (..)
  , HasLocationMaybe (..)

    -- ** File
  , File (..)
  , inFile
  , file

    -- ** Position
  , Position (..)
  , position
  , Extent (..)
  , extent
  , Columns (..)
  , line
  , startColumn
  , endColumn
  , Line (..)
  , atLine
  , Column (..)
  , atColumn

    -- * Anatomy of a command
  , Command

    -- ** Name
  , Name (..)
  , HasName (..)

    -- ** Message
  , Message (..)
  , HasMessage (..)

    -- ** Properties
  , Properties
  , HasProperties (..)
  , Key (..)
  , Value (..)
  ) where

import GitHub.Workflow.Command.Annotation.Commands.Debug
import GitHub.Workflow.Command.Annotation.Commands.Error
import GitHub.Workflow.Command.Annotation.Commands.Notice
import GitHub.Workflow.Command.Annotation.Commands.Warning
import GitHub.Workflow.Command.Annotation.File
import GitHub.Workflow.Command.Annotation.Location
import GitHub.Workflow.Command.Annotation.Position
import GitHub.Workflow.Command.Annotation.Position.Column
import GitHub.Workflow.Command.Annotation.Position.Columns
import GitHub.Workflow.Command.Annotation.Position.Extent
import GitHub.Workflow.Command.Annotation.Position.Line
import GitHub.Workflow.Command.Execution
import GitHub.Workflow.Command.Grouping
import GitHub.Workflow.Command.Masking
import GitHub.Workflow.Command.Stopping
import GitHub.Workflow.Command.Syntax