GitHub.Workflow.Command.Execution

Documentation

class Monad m => MonadCommand m where

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 ()

Instances

MonadCommand IO

Defined in GitHub.Workflow.Command.Execution

Methods

executeCommand :: ToCommand a => a -> IO ()

MonadIO m => MonadCommand (PrintCommands m)

Defined in GitHub.Workflow.Command.Execution

Methods

executeCommand :: ToCommand a => a -> PrintCommands m ()

newtype PrintCommands m a

Constructors

PrintCommands (m a)

Instances

MonadIO m => MonadIO (PrintCommands m)

Defined in GitHub.Workflow.Command.Execution

Methods

liftIO :: IO a -> PrintCommands m a

Applicative m => Applicative (PrintCommands m)

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)

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)

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)

Defined in GitHub.Workflow.Command.Execution

Methods

executeCommand :: ToCommand a => a -> PrintCommands m ()