Index

A D E F G I M N P S T W
All Classes and Interfaces|All Packages

A

AnnotationProperties - Class in me.julb.sdk.github.actions.kit

Optional properties which can be sent with logging commands (notice, error, and warning).

AnnotationProperties() - Constructor for class me.julb.sdk.github.actions.kit.AnnotationProperties

D

debug(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Prints a DEBUG message to user log.

E

endGroup() - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Ends a group.

error(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Prints a ERROR message to user log.

error(String, Optional<AnnotationProperties>) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Prints a ERROR message to user log with given annotation properties.

ExecCommand<P,M> - Class in me.julb.sdk.github.actions.kit

A command to issue in the GitHub action.

ExecCommand() - Constructor for class me.julb.sdk.github.actions.kit.ExecCommand

execute() - Method in interface me.julb.sdk.github.actions.spi.GitHubActionProvider

Executes the GitHub action.

exit(int) - Method in interface me.julb.sdk.github.actions.kit.SystemProxy

Exits the program with the given code.

exit(int) - Method in class me.julb.sdk.github.actions.kit.SystemProxySystemImpl

Exits the program with the given code.

F

fail(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Fails the process with the given message.

G

getBooleanInput(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the boolean input with the given name.

getEnumInput(String, Class<T>) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the input value with the given name as an Enum.

getenv(String) - Method in interface me.julb.sdk.github.actions.kit.SystemProxy

Gets the value of the given environment variable name.

getenv(String) - Method in class me.julb.sdk.github.actions.kit.SystemProxySystemImpl

Gets the value of the given environment variable name.

getEnv(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the environment variable value.

getGitHubAbbreviatedSha() - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Returns the commit abbreviated SHA that triggered the workflow.

getGitHubApiUrl() - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Returns the GitHub API url.

getGitHubRef() - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Returns the branch or tag ref that triggered the workflow run.

getGitHubRefName() - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Returns the branch or tag name that triggered the workflow run.

getGitHubRefType() - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Returns the type of ref that triggered the workflow run.

getGitHubRepository() - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Returns the owner and repository name.

getGitHubRunId() - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Returns the workflow run identifier.

getGitHubSha() - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Returns the commit SHA that triggered the workflow.

getImplementation() - Static method in class me.julb.sdk.github.actions.spi.GitHubActionServiceLoader

Gets the GitHub action provider implementation using Java SPI.

getInput(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the input with the given name.

getInput(String, boolean) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the input with the given name, with the option to trim the value.

getMultilineInput(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the multiline input with the given name.
Each value is trimmed and blank values are not returned.

getMultilineInput(String, boolean) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the multiline input with the given name.
Blank values are not returned.

getRequiredBooleanInput(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the boolean input with the given name.
This method throws a NoSuchElementException if the input does not exist.

getRequiredEnumInput(String, Class<T>) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the enum input value with the given name as an Enum.
This method throws a NoSuchElementException if the input does not exist.

getRequiredEnv(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets an environment variable value.

getRequiredInput(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the input with the given name.
This method throws a NoSuchElementException if the input does not exist.

getRequiredInput(String, boolean) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the input with the given name.
This method throws a NoSuchElementException if the input does not exist.

getRequiredMultilineInput(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the multiline input with the given name.

This method throws a NoSuchElementException if the input does not exist.
Each value is trimmed and blank values are not returned.

getRequiredMultilineInput(String, boolean) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Gets the multiline input with the given name.

This method throws a NoSuchElementException if the input does not exist.
Blank values are not returned.

getState(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

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

GitHubActionProvider - Interface in me.julb.sdk.github.actions.spi

The SPI interface to define a GitHub action.

GitHubActionServiceLoader - Class in me.julb.sdk.github.actions.spi

The Service Loader helper used to load a GitHub action.

GitHubActionServiceLoader() - Constructor for class me.julb.sdk.github.actions.spi.GitHubActionServiceLoader

GitHubActionsKit - Class in me.julb.sdk.github.actions.kit

Kit methods for GitHub actions.

GitHubActionsKit() - Constructor for class me.julb.sdk.github.actions.kit.GitHubActionsKit

group(String, Runnable) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Executes the given Runnable in a group.

group(String, Callable<T>) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Executes the given callable in a group.

I

INSTANCE - Static variable in class me.julb.sdk.github.actions.kit.GitHubActionsKit

The public instance to use.

isDebug() - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Returns true if DEBUG mode is enabled in the runner, false otherwise.

isGitHubRefTypeBranch() - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Returns true if the type of ref that triggered the workflow run is branch.

isGitHubRefTypeTag() - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Returns true if the type of ref that triggered the workflow run is tag.

M

me.julb.sdk.github.actions.kit - package me.julb.sdk.github.actions.kit

me.julb.sdk.github.actions.spi - package me.julb.sdk.github.actions.spi

N

notice(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Prints a NOTICE message to user log.

notice(String, Optional<AnnotationProperties>) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Prints a NOTICE message to user log.

P

println() - Method in interface me.julb.sdk.github.actions.kit.SystemProxy

Prints a line feed on STDOUT.

println() - Method in class me.julb.sdk.github.actions.kit.SystemProxySystemImpl

Prints a line feed on STDOUT.

println(T) - Method in interface me.julb.sdk.github.actions.kit.SystemProxy

Prints a message on STDOUT.

println(T) - Method in class me.julb.sdk.github.actions.kit.SystemProxySystemImpl

Prints a message on STDOUT.

S

saveState(String, T) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

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

setCommandEcho(boolean) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Enables or disables the echoing of commands into STDOUT for the rest of the step.
Echoing is disabled by default if ACTIONS_STEP_DEBUG is not set.

setEmptyOutput(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Sets the given output variable with an empty value.

setOptionalOutput(String, Optional<T>) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Sets the given output variable.

setOutput(String, T) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Sets the given output variable.

setSecret(T) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Registers a secret which will get masked from logs.

startGroup(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Starts a group with the given name.
Output until the call to GitHubActionsKit.endGroup() will be foldable.

SystemProxy - Interface in me.julb.sdk.github.actions.kit

An interface proxyfying access to System functions.

SystemProxySystemImpl - Class in me.julb.sdk.github.actions.kit

The class using System functions to implement SystemProxy.

SystemProxySystemImpl() - Constructor for class me.julb.sdk.github.actions.kit.SystemProxySystemImpl

T

toMap() - Method in class me.julb.sdk.github.actions.kit.AnnotationProperties

Serializes the properties as a Map.

toString() - Method in class me.julb.sdk.github.actions.kit.ExecCommand

W

warning(String) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Prints a WARNING message to user log.

warning(String, Optional<AnnotationProperties>) - Method in class me.julb.sdk.github.actions.kit.GitHubActionsKit

Prints a WARNING message to user log.

A D E F G I M N P S T W
All Classes and Interfaces|All Packages