Module

GitHub.Actions.Core

Exports functions from the @actions/core module provided by GitHub https://github.com/actions/toolkit/tree/main/packages/core

#InputOptions 

type InputOptions = { required :: Boolean }

Interface for getInput options required: Whether the input is required. If required and not present, will throw required default: false

#exportVariable 

exportVariable :: { key :: String, value :: String } -> Effect Unit

Sets env variable for this action and future actions in the job name: the name of the variable to set val: the value of the variable

#setSecret 

setSecret :: String -> Effect Unit

Registers a secret which will get masked from logs

#addPath 

addPath :: String -> Effect Unit

Prepends input path to the PATH (for this action and future actions)

#getInput 

getInput :: GetInputArgs -> ExceptT Error Effect String

Gets the value of an input. The value is also trimmed. name: the name of the input to get options: See InputOptions

#getInput' 

getInput' :: String -> ExceptT Error Effect String

Gets the value of an input. The value is also trimmed. Uses default for options

#setOutput 

setOutput :: { name :: String, value :: String } -> Effect Unit

Sets the value of an output.

#setCommandEcho 

setCommandEcho :: Boolean -> Effect Unit

Enables or disables the echoing of commands into stdout for the rest of the step.

#setFailed 

setFailed :: String -> Effect Unit

Sets the action status to failed. When the action exits it will be with an exit code of 1

#isDebug 

isDebug :: Effect Boolean

Gets whether Actions Step Debug is on or not

#debug 

debug :: String -> Effect Unit

Writes debug message to user log

#error 

error :: String -> Effect Unit

Adds an error issue

#warning 

warning :: String -> Effect Unit

Adds a warning issue

#info 

info :: String -> Effect Unit

Writes info to log with console.log.

#startGroup 

startGroup :: String -> Effect Unit

Begin an output group. Output until the next groupEnd will be foldable in this group

#endGroup 

endGroup :: Effect Unit

End an output group.

#saveState 

saveState :: { name :: String, value :: String } -> Effect Unit

Saves state for current action. The state can only be retrieved by this action's post job execution.

#getState 

getState :: String -> Effect String

Gets the value of an state set by this action's main execution.

#group 

group :: forall a. { fn :: Aff a, name :: String } -> Aff a

Wrap an asynchronous function call in a group.

Modules