core library Null safety

Classes

AnnotationProperties
Optional properties that can be sent with annotation commands (notice, error, and warning)
ExitCode
The code to exit an action.
InputOptions
Interface for getInput options.
Summary
SummaryImageOptions
SummaryTableCell

Functions

addPath({required String path}) → void
Prepends inputPath to the PATH (for this action and future actions).
debug({required String message}) → void
Writes debug message to user log.
endGroup() → void
End an output group.
error({required String message, AnnotationProperties? properties}) → void
Adds an error message with optional properties.
exportVariable({required String name, required Object value}) → void
Sets env variable for this action and future actions in the job.
getBooleanInput({required String name, InputOptions options = const InputOptions()}) bool
Gets the input value of the boolean type in the YAML 1.2 "core schema" specification.
getInput({required String name, InputOptions options = const InputOptions()}) String
Gets the value of an input.
getMultilineInput({required String name, InputOptions options = const InputOptions()}) Iterable<String>
Gets the values of a multiline input. Each value is also trimmed.
getState({required String name}) String
Gets the value of an state set by this action's main execution.
group<T>({required String name, required Future<T> fn()}) Future<T?>
Wraps an asynchronous function call in a group.
info({required String message}) → void
Writes info message to log with console.log.
isDebug() bool
Gets whether Actions Step Debug is on or not
notice({required String message, AnnotationProperties? properties}) → void
Adds a notice issue message with optional properties.
saveState({required String name, required Object value}) → void
Saves state for current action.
setCommandEcho({required bool enabled}) → void
Enables or disables the echoing of commands into stdout for the rest of the step.
setFailed({required String message}) → void
Sets the action status to failed.
setOutput({required String name, required Object value}) → void
Sets the value of an output.
setSecret(String secret) → void
Registers a secret which will get masked from logs.
startGroup({required String name}) → void
Begin an output group.
toPlatformPath(String pth) String
Converts the given path to a platform-specific path.
toPosixPath(String pth) String
Converts the given path to the posix form.
toWin32Path(String pth) String
Converts the given path to the win32 form.
warning({required String message, AnnotationProperties? properties}) → void
Adds an warning message with optional properties.