GitHub.Workflow.Command.Stopping

Basic usage

suspendCommands

Arguments

:: (MonadCommand m, MonadRandom m)

=> m a

Commands issued by this action will have no effect

-> m a

Run an action with processing of workflow commands suspended

GitHub documentation: Stopping and starting workflow commands

Stop and resume

stopCommands :: (MonadCommand m, MonadRandom m) => m SuspendToken

Stops processing any workflow commands

This special command allows you to log anything without accidentally running a workflow command.

resumeCommands :: MonadCommand m => SuspendToken -> m ()

Resume processing workflow commands

newtype SuspendToken

Constructors

SuspendToken Text

Manual token management

randomSuspendToken :: MonadRandom m => m SuspendToken

suspendCommandsWithToken :: MonadCommand m => SuspendToken -> m a -> m a

stopCommandsWithToken :: MonadCommand m => SuspendToken -> m ()

Command types

newtype StopCommands

Constructors

StopCommands

Fields

• token :: SuspendToken

Instances

ToCommand StopCommands

Defined in GitHub.Workflow.Command.Stopping

Methods

addToCommand :: StopCommands -> Command -> Command

newtype ResumeCommands

Constructors

ResumeCommands

Fields

• token :: SuspendToken

Instances

ToCommand ResumeCommands

Defined in GitHub.Workflow.Command.Stopping

Methods

addToCommand :: ResumeCommands -> Command -> Command