Class UseAction
-
- All Implemented Interfaces:
-
io.typeflows.util.Renderable
public final class UseAction extends ActionStep
A workflow step that executes an external GitHub Action.
UseAction enables the execution of actions from the GitHub Marketplace, public repositories, or specific tagged versions of actions. Actions are referenced using the standard GitHub format (e.g., 'actions/checkout@v4', 'owner/repo@ref'). This step type provides access to the vast ecosystem of reusable actions for common tasks like code checkout, environment setup, deployment, testing, and more.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classUseAction.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 UseAction.CompanionCompanion
-
Method Summary
Modifier and Type Method Description final StringgetUses()final StringgetName()final static UseActioncreate(String uses, Configure<ActionStep.DSL> step)Creates and configures a UseAction instance without a name. final static UseActioncreate(String uses)Creates and configures a UseAction instance without a name. final static UseActioncreate(String uses, String name, Configure<ActionStep.DSL> step)Creates and configures a UseAction instance with an optional name. -
-
Method Detail
-
create
@JvmOverloads() final static UseAction create(String uses, Configure<ActionStep.DSL> step)
Creates and configures a UseAction instance without a name.
- Parameters:
uses- The action reference (e.g.step- Configuration lambda to customize the step- Returns:
Configured UseAction instance
-
create
@JvmOverloads() final static UseAction create(String uses)
Creates and configures a UseAction instance without a name.
- Parameters:
uses- The action reference (e.g.- Returns:
Configured UseAction instance
-
create
final static UseAction create(String uses, String name, Configure<ActionStep.DSL> step)
Creates and configures a UseAction instance with an optional name.
- Parameters:
uses- The action reference (e.g.name- Optional name for the step (for logging and identification)step- Configuration lambda to customize the step- Returns:
Configured UseAction instance
-
-
-
-