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.

    • Constructor Detail

    • 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 directory
        name - 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 directory
        name - 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 action
        name - 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 action
        name - 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 reference
        name - 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 reference
        name - 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