Workflow 0.29.0-beta API

All Implemented Interfaces:

io.typeflows.fs.TypeflowsFSEntry , io.typeflows.util.Named , io.typeflows.util.Renderable
```
public final class Workflow
extends TypeflowsFile<YamlContent>
                    
```
Represents a GitHub Actions workflow configuration.
A workflow is an automated procedure that you add to your repository. Workflows are defined by YAML files in the .github/workflows directory and consist of one or more jobs that can run on scheduled events, manual triggers, or in response to repository activity.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`Workflow.DSL`
`public final class`	`Workflow.Strategy`
`public class`	`Workflow.Inputs`
`public class`	`Workflow.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`public final String`	`displayName`
`public final List<Job>`	`jobs`
`public final List<WorkflowTrigger>`	`on`
`public final Map<String, Object>`	`env`
`public final Defaults`	`defaults`
`public final Permissions`	`permissions`
`public final String`	`concurrency`
`public final String`	`description`
`private final String`	`name`
`public final static Workflow.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`getName()`
`final String`	`safeName()`
`YamlContent`	`render()`
`final static Workflow`	`create(String filename, Configure<Workflow.DSL> block)`	Creates and configures a Workflow instance.
`final static Workflow`	`create(String filename)`	Creates and configures a Workflow 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
  - getName
```
 String getName()
```
  - safeName
```
 final String safeName()
```
  - render
```
 YamlContent render()
```
  - create
```
@JvmOverloads() final static Workflow create(String filename, Configure<Workflow.DSL> block)
```
    Creates and configures a Workflow instance.
    
    Parameters:
    
    filename - The name of the workflow - appears as the YAML filename in .
    
    block - Configuration lambda to set up the workflow
    
    Returns:
    
    Configured Workflow instance
  - create
```
@JvmOverloads() final static Workflow create(String filename)
```
    Creates and configures a Workflow instance.
    
    Parameters:
    
    filename - The name of the workflow - appears as the YAML filename in .
    
    Returns:
    
    Configured Workflow instance