core

func AddToPath ¶

func AddToPath(dir string) error

AddToPath executes a GitHub Workflow command to add a directory to the system PATH for subsequent workflow steps, and prepends it to the current process's PATH so code later in this step finds its executables too, as the JS toolkit's addPath does. Unlike addPath, the current process is changed only after the runner file is written, so a failed call changes nothing. The runner reads GITHUB_PATH as one directory per line, so dir must not contain a line break. GitHub Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#adding-a-system-path

func Debug ¶

func Debug(message string) error

Debug writes a debug message to stdout as a WorkflowCommand. GitHub Debug Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#setting-a-debug-message

func EndGroup ¶

func EndGroup() error

EndGroup closes the most recent collapsible log group. GitHub Group Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#grouping-log-lines

func Error ¶

func Error(message string, options *WorkflowCommandOptions) error

Error writes an error message to stdout as a WorkflowCommand. GitHub Error Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#setting-an-error-message

func GetBooleanInput ¶

func GetBooleanInput(name string, opts *InputOptions) (bool, error)

GetBooleanInput reads a GitHub Actions input by name and interprets it as a boolean. It accepts only the YAML 1.2 "Core Schema" boolean strings: "true", "True", "TRUE" evaluate to true; "false", "False", "FALSE" evaluate to false. Any other value returns ErrInvalidBooleanInput (wrapped). GetBooleanInput propagates ErrInputRequired from GetInput when opts.Required is true. GitHub Actions Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/variables

func GetIDToken ¶ added in v0.2.0

func GetIDToken(ctx context.Context, audience string) (string, error)

GetIDToken requests a GitHub OIDC ID token (a JWT) for audience, for exchanging with a cloud provider or another service that trusts GitHub's OIDC issuer. An empty audience requests GitHub's default, which is the URL of the repository owner. The token is masked in the log (as with MaskValue) before it is returned.

The job needs the id-token: write permission:

permissions:
  id-token: write
  contents: read

Without it, on pull requests from forks, and outside GitHub Actions, the runner provides no request credentials and GetIDToken returns ErrIDTokenUnavailable.

Differences from the JS toolkit's getIDToken: a request that fails with 502, 503 or 504 is retried at most twice, with a one- then two-second delay, where JS makes up to ten attempts; and if masking the token fails, GetIDToken returns that error rather than the unmasked token.

GitHub Reference: https://docs.github.com/en/actions/reference/security/oidc

func GetInput ¶

func GetInput(name string, opts *InputOptions) (string, error)

GetInput reads a GitHub Actions input by name, applying the options in opts. The input is resolved from the environment variable INPUT_<NAME>, where <NAME> is the input name with spaces replaced by underscores and converted to uppercase. Hyphens in the name are preserved. If opts is nil it is treated as a zero InputOptions (not required, trim whitespace). GetInput returns ErrInputRequired (wrapped) when opts.Required is true and the input is unset or empty. GitHub Actions Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/variables

os.Setenv("INPUT_NAME", "  Mona  ")
val, err := GetInput("name", nil)
if err != nil {
	fmt.Println("error:", err)
	return
}
fmt.Println(val)

Output:
Mona

func GetMultilineInput ¶

func GetMultilineInput(name string, opts *InputOptions) ([]string, error)

GetMultilineInput reads a GitHub Actions input by name and splits the value on newlines. Empty lines are dropped from the result. Each line is trimmed of surrounding whitespace unless opts.TrimWhitespace points to false. GetMultilineInput returns a nil slice when the input is unset or resolves to no non-empty lines. GetMultilineInput propagates ErrInputRequired from GetInput when opts.Required is true. GitHub Actions Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/variables

func GetState ¶ added in v0.2.0

func GetState(name string) string

GetState returns the value saved with SetState under name, read from the STATE_<name> environment variable the runner sets for the action's pre and post steps. It returns an empty string when no such state was saved. GitHub Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#sending-values-to-the-pre-and-post-actions

func Group ¶ added in v0.2.0

func Group(name string, fn func() error) error

Group runs fn inside a collapsible log group named name, and always closes the group, even when fn fails. It returns fn's error joined with any error closing the group. If the group cannot be opened, fn is not run, as with the JS toolkit's group. To return a value from fn, assign it to a variable fn captures. GitHub Group Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#grouping-log-lines

func Info ¶ added in v0.2.0

func Info(message string) error

Info writes message to the log as plain text, followed by a newline, as the JS toolkit's info does. The message is not escaped: a line that starts with "::" is read by the runner as a workflow command.

func IsDebug ¶ added in v0.2.0

func IsDebug() bool

IsDebug reports whether the runner has step debug logging enabled, which GitHub signals by setting RUNNER_DEBUG to 1. Like the JS toolkit's isDebug, only the exact value "1" counts; actioncontext's RunnerDebug field also accepts other strconv.ParseBool true values, which GitHub does not send. GitHub Reference: https://docs.github.com/en/actions/how-tos/monitor-workflows/enable-debug-logging

func MaskValue ¶

func MaskValue(value string) error

MaskValue instructs GitHub Actions to redact the provided value from logs. GitHub Mask Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#masking-a-value-in-a-log

func Notice ¶

func Notice(message string, options *WorkflowCommandOptions) error

Notice writes a notice message to stdout as a WorkflowCommand. GitHub Notice Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#setting-a-notice-message

func SetCommandEcho ¶ added in v0.2.0

func SetCommandEcho(enabled bool) error

SetCommandEcho turns echoing of workflow commands in the log on or off for the current step, as the JS toolkit's setCommandEcho does. By default commands are echoed only when step debug logging is enabled. The add-mask, debug, warning and error commands are never echoed. The echo command is documented in the JS toolkit rather than GitHub's workflow command reference: https://github.com/actions/toolkit/blob/main/docs/commands.md#command-echoing

func SetEnv ¶

func SetEnv(key, value string) error

SetEnv executes a GitHub Workflow command to set an environment variable in subsequent workflows steps, and sets it in the current process so code later in this step sees it too, as the JS toolkit's exportVariable does. Unlike exportVariable, the current process is changed only after the runner file is written, so a failed call changes nothing. GitHub Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable

func SetFailed ¶ added in v0.2.0

func SetFailed(message string)

SetFailed writes message as an error annotation and exits the process with status 1, failing the step.

The JS toolkit's setFailed only sets the exit code and lets the action keep running; Go cannot set an exit code for later, so SetFailed exits immediately. Deferred functions do not run, so write anything buffered first, in particular StepSummary with Summary.Write. To fail with more control, write the error with Error and return from main with os.Exit(1) yourself. GitHub Error Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#setting-an-error-message

func SetOutput ¶

func SetOutput(key, value string) error

SetOutput executes a GitHub Workflow command to set a step output. GitHub Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#setting-an-output-parameter

func SetOutputJSON ¶ added in v0.2.0

func SetOutputJSON(key string, v any) error

SetOutputJSON sets a step output to v encoded as JSON, for a workflow to read with fromJSON(steps.<id>.outputs.<name>), as the JS toolkit's setOutput does for a value that is not a string. v is encoded with encoding/json, so it follows the same struct tags as elsewhere; map keys are sorted, and <, > and & are written as \u003c, \u003e and \u0026, which fromJSON reads back unchanged. A string is encoded as a quoted JSON string; use SetOutput to set a plain string output. GitHub Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#setting-an-output-parameter

func SetState ¶

func SetState(key, value string) error

SetState executes a GitHub Workflow command to set a state parameter which is available to post-actions GitHub Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#sending-values-to-the-pre-and-post-actions

func StartGroup ¶

func StartGroup(name string) error

StartGroup begins a collapsible log group. GitHub Group Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#grouping-log-lines

func ToPlatformPath ¶ added in v0.2.0

func ToPlatformPath(pth string) string

ToPlatformPath returns pth with every forward slash and backslash replaced by the separator of the OS running the action (os.PathSeparator), as the JS toolkit's toPlatformPath does. A backslash is converted even on Unix, where it is a legal filename character.

func ToPosixPath ¶ added in v0.2.0

func ToPosixPath(pth string) string

ToPosixPath returns pth with every backslash replaced by a forward slash, as the JS toolkit's toPosixPath does. Unlike filepath.ToSlash, which changes nothing outside Windows, it converts on every OS, for paths that come from a different OS than the one running the action. A backslash is converted even on Unix, where it is a legal filename character.

func ToWin32Path ¶ added in v0.2.0

func ToWin32Path(pth string) string

ToWin32Path returns pth with every forward slash replaced by a backslash, as the JS toolkit's toWin32Path does. Unlike filepath.FromSlash, which changes nothing outside Windows, it converts on every OS.

func Warning ¶

func Warning(message string, options *WorkflowCommandOptions) error

Warning writes a warning message to stdout as a WorkflowCommand. GitHub Warning Command Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#setting-a-warning-message