Class Action

  • All Implemented Interfaces:
    io.typeflows.fs.TypeflowsFSEntry , io.typeflows.util.Named , io.typeflows.util.Renderable

    
    public final class Action
    extends TypeflowsFile<YamlContent> implements Renderable<YamlContent>
                        

    Represents a custom GitHub Action definition.

    A custom action is a reusable unit of code that performs a specific task. Custom actions can accept inputs, produce outputs, and execute a series of steps using the composite run type. This class enables creating action.yml files that define composite actions for reuse across workflows.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public final class Action.DSL
      public class Action.Companion
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      String getName()
      YamlContent render()
      final static Action create(String name, String description, Configure<Action.DSL> block) Creates and configures an Action instance.
      final static Action create(String name, String description) Creates and configures an Action instance.
      • Methods inherited from class io.typeflows.fs.TypeflowsFile

        writeTo
      • Methods inherited from class io.typeflows.util.Base

        equals, hashCode, toString
      • Methods inherited from class io.typeflows.fs.TypeflowsFSEntry

        plus
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • create

        @JvmOverloads() final static Action create(String name, String description, Configure<Action.DSL> block)

        Creates and configures an Action instance.

        Parameters:
        name - The name of the action
        description - A description of what the action does
        block - Configuration lambda to set up the action
        Returns:

        Configured Action instance

      • create

        @JvmOverloads() final static Action create(String name, String description)

        Creates and configures an Action instance.

        Parameters:
        name - The name of the action
        description - A description of what the action does
        Returns:

        Configured Action instance