typeflows-github/io.typeflows.github.workflows/Workflow

Workflow

class Workflow : 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.

Types

object Companion

object Inputs : PublicContext

class Strategy : Context

Properties

var concurrency: String?

var defaults: Defaults?

var description: String?

Optional description for documentation and visualization purposes. This field is not rendered in the actual workflow YAML.

var displayName: String?

val env: Settings

val jobs: MutableList<Job>

open override val name: String

var on: MutableList<WorkflowTrigger>

var permissions: Permissions?

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun render(): YamlContent

fun safeName(): String

open override fun toString(): String

open override fun writeTo(parent: File)