Class UseLocalAction
-
- All Implemented Interfaces:
-
io.typeflows.util.Renderable
public final class UseLocalAction extends ActionStep
A workflow step that executes a local action from within the same repository.
UseLocalAction enables the execution of custom actions that are stored locally in the repository's .github/actions directory. These actions are typically defined by action.yml files and can include composite actions, Docker container actions, or JavaScript actions. This step type is ideal for reusable workflows and actions that are specific to a particular repository or organization and don't need to be published publicly.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classUseLocalAction.Companion
-
Field Summary
Fields Modifier and Type Field Description private final Stringusespublic final IntegertimeoutMinutespublic final BooleancontinueOnErrorpublic final PathworkingDirectorypublic final Map<String, Object>withpublic final Map<String, Object>envprivate final Stringnamepublic final Stringidpublic final Expressionconditionpublic final Map<String, Object>extrapublic final static UseLocalAction.CompanionCompanion
-
Method Summary
Modifier and Type Method Description final StringgetUses()final StringgetName()final static UseLocalActioncreate(String uses, String name, Configure<ActionStep.DSL> step)Creates and configures a UseLocalAction instance using an action name. final static UseLocalActioncreate(String uses, String name)Creates and configures a UseLocalAction instance using an action name. final static UseLocalActioncreate(String uses)Creates and configures a UseLocalAction instance using an action name. final static UseLocalActioncreate(Path uses, String name, Configure<ActionStep.DSL> step)Creates and configures a UseLocalAction instance using a Path. final static UseLocalActioncreate(Path uses, String name)Creates and configures a UseLocalAction instance using a Path. final static UseLocalActioncreate(Path uses)Creates and configures a UseLocalAction instance using a Path. final static UseLocalActioncreate(Action uses, String name, Configure<ActionStep.DSL> step)Creates and configures a UseLocalAction instance using an Action class. final static UseLocalActioncreate(Action uses, String name)Creates and configures a UseLocalAction instance using an Action class. final static UseLocalActioncreate(Action uses)Creates and configures a UseLocalAction instance using an Action class. -
-
Method Detail
-
create
@JvmOverloads() final static UseLocalAction create(String uses, String name, Configure<ActionStep.DSL> step)
Creates and configures a UseLocalAction instance using an action name. The action is expected to be in the .github/actions/{name} directory.
- Parameters:
uses- The name of the local action directoryname- Optional name for the step (for logging and identification)step- Configuration lambda to customize the step- Returns:
Configured UseLocalAction instance
-
create
@JvmOverloads() final static UseLocalAction create(String uses, String name)
Creates and configures a UseLocalAction instance using an action name. The action is expected to be in the .github/actions/{name} directory.
- Parameters:
uses- The name of the local action directoryname- Optional name for the step (for logging and identification)- Returns:
Configured UseLocalAction instance
-
create
@JvmOverloads() final static UseLocalAction create(String uses)
Creates and configures a UseLocalAction instance using an action name. The action is expected to be in the .github/actions/{name} directory.
- Parameters:
uses- The name of the local action directory- Returns:
Configured UseLocalAction instance
-
create
@JvmOverloads() final static UseLocalAction create(Path uses, String name, Configure<ActionStep.DSL> step)
Creates and configures a UseLocalAction instance using a Path.
- Parameters:
uses- The path to the local actionname- Optional name for the step (for logging and identification)step- Configuration lambda to customize the step- Returns:
Configured UseLocalAction instance
-
create
@JvmOverloads() final static UseLocalAction create(Path uses, String name)
Creates and configures a UseLocalAction instance using a Path.
- Parameters:
uses- The path to the local actionname- Optional name for the step (for logging and identification)- Returns:
Configured UseLocalAction instance
-
create
@JvmOverloads() final static UseLocalAction create(Path uses)
Creates and configures a UseLocalAction instance using a Path.
- Parameters:
uses- The path to the local action- Returns:
Configured UseLocalAction instance
-
create
@JvmOverloads() final static UseLocalAction create(Action uses, String name, Configure<ActionStep.DSL> step)
Creates and configures a UseLocalAction instance using an Action class. The action path is derived from the class name.
- Parameters:
uses- The Action class referencename- Optional name for the step (for logging and identification)step- Configuration lambda to customize the step- Returns:
Configured UseLocalAction instance
-
create
@JvmOverloads() final static UseLocalAction create(Action uses, String name)
Creates and configures a UseLocalAction instance using an Action class. The action path is derived from the class name.
- Parameters:
uses- The Action class referencename- Optional name for the step (for logging and identification)- Returns:
Configured UseLocalAction instance
-
create
@JvmOverloads() final static UseLocalAction create(Action uses)
Creates and configures a UseLocalAction instance using an Action class. The action path is derived from the class name.
- Parameters:
uses- The Action class reference- Returns:
Configured UseLocalAction instance
-
-
-
-