dart_github_actions library
Classes
- Action
- The base of any Github Action.
- ActionOutput
- The base for all Action outputs.
- ActionStep
- A job step that runs the specified action.
-
ActionStepWithOutput<
T extends StepOutput> - An ActionStep that exposes one more more outputs.
-
ActionWithOutputs<
T extends ActionOutput> - An action that has outputs.
- CommandStep
- A job step that runs the given command.
-
CommandStepWithOutput<
T extends StepOutput> - A CommandStep that exposes one more more outputs.
- CustomAction
- Used in place of extending Action or ActionWithOutputs to provide an Action definition without needing to explicitly type its inputs and outputs.
- CustomActionOutput
- A simple ActionOutput used to expose the outputs of CustomAction.
- Defaults
- A set of defaults to apply to a Job.
- Expression
- A type-safe representation of Github Actions Expressions.
- ExpressionContext
- An object givnig access to all types of Contexts.
- Job
- A job that is run as a part of a workflow.
- JobOutput
- The base for all Job outputs.
-
JobWithOutput<
T extends JobOutput> - A Job that exposes one ore more outputs that can be used in another Job.
- PullRequest
- Triggers a workflow when a pull request is made to the repository.
- Push
- Triggers a workflow when a push is made to the repository.
- Run
- Step
- The base class for all steps that can be contained by a job.
- StepOutput
- The base for all Step outputs.
-
StepWithOutput<
T extends StepOutput> - The base for all Steps with outputs.
- Trigger
- An event that causes a workflow to run.
- Workflow
- A Github Workflow which runs one or more Jobs.
- YamlStringList
-
A string list representation that will be written as
string1, string2. - YAMLWriter
- A serializer for writing objects in yaml format.
Enums
- PullRequestType
- Type associated with the pull request webhook event.
- RunnerType
- Available GitHub-hosted runner types.
Mixins
- YAMLObject
- Provides a method to serialize an object to a map capabable of being written to yaml.
Extensions
- JobX on Job
- Job extension methods for adding CommandStep and ActionSteps.
-
MapX
on Map<
String, T?> - Map extensions.
- StringBufferX on StringBuffer
- StringBuffer extensions.
Typedefs
- ExpressionWithContext = String Function(ExpressionContext context)
- A representation of a funciton that produces a Github Expression.
-
StepOutputBuilder<
T extends StepOutput> = T Function(String stepId) -
A function definition for building a StepOutput given the
stepId.