Struct Workflow

pub struct Workflow {
    pub name: Option<String>,
    pub env: Option<Env>,
    pub run_name: Option<String>,
    pub on: Option<Event>,
    pub permissions: Option<Permissions>,
    pub jobs: Option<Jobs>,
    pub concurrency: Option<Concurrency>,
    pub defaults: Option<Defaults>,
    pub secrets: Option<IndexMap<String, Secret>>,
    pub timeout_minutes: Option<u32>,
}

Represents the configuration for a GitHub workflow.

A workflow is a configurable automated process made up of one or more jobs. This struct defines the properties that can be set in a workflow YAML file for GitHub Actions, including the name, environment variables, permissions, jobs, concurrency settings, and more.

Fields

name: Option<String>

The name of the workflow. GitHub displays the names of your workflows under your repository’s “Actions” tab.

env: Option<Env>

Environment variables that can be used in the workflow.

run_name: Option<String>

The name for workflow runs generated from the workflow. GitHub displays the workflow run name in the list of workflow runs.

on: Option<Event>

The event that triggers the workflow. This can include events like push, pull_request, etc.

permissions: Option<Permissions>

Permissions granted to the GITHUB_TOKEN for the workflow.

jobs: Option<Jobs>

The jobs that are defined in the workflow.

concurrency: Option<Concurrency>

Concurrency settings for the workflow, allowing control over how jobs are executed.

defaults: Option<Defaults>

Default settings for jobs in the workflow.

secrets: Option<IndexMap<String, Secret>>

Secrets that can be used in the workflow, such as tokens or passwords.

timeout_minutes: Option<u32>

The maximum number of minutes a job can run before it is canceled.

Implementations

impl Workflow

pub fn name(self, value: impl Into<String>) -> Self

Sets the name field of this struct.

pub fn env(self, value: impl Into<Env>) -> Self

Sets the env field of this struct.

pub fn run_name(self, value: impl Into<String>) -> Self

Sets the run_name field of this struct.

pub fn on(self, value: impl Into<Event>) -> Self

Sets the on field of this struct.

pub fn permissions(self, value: impl Into<Permissions>) -> Self

Sets the permissions field of this struct.

pub fn jobs(self, value: impl Into<Jobs>) -> Self

Sets the jobs field of this struct.

pub fn concurrency(self, value: impl Into<Concurrency>) -> Self

Sets the concurrency field of this struct.

pub fn defaults(self, value: impl Into<Defaults>) -> Self

Sets the defaults field of this struct.

pub fn secrets(self, value: impl Into<IndexMap<String, Secret>>) -> Self

Sets the secrets field of this struct.

pub fn timeout_minutes(self, value: impl Into<u32>) -> Self

Sets the timeout_minutes field of this struct.

impl Workflow

pub fn new<T: ToString>(name: T) -> Self

Creates a new Workflow with the specified name.

pub fn to_string(&self) -> Result<String>

Converts the Workflow to a YAML string representation.

pub fn add_job_when<T: ToString, J: Into<Job>>( self, cond: bool, id: T, job: J, ) -> Self

Adds a job to the workflow when a condition is met.

pub fn add_job<T: ToString, J: Into<Job>>(self, id: T, job: J) -> Self

Adds a job to the workflow with the specified ID and job configuration.

pub fn parse(yml: &str) -> Result<Self>

Parses a YAML string into a Workflow.

pub fn generate(self) -> Result<()>

Generates the workflow using the Generate struct.

pub fn add_event<T: Into<Event>>(self, that: T) -> Self

Adds an event to the workflow.

pub fn add_event_when<T: Into<Event>>(self, cond: bool, that: T) -> Self

Adds an event to the workflow when a condition is met.

pub fn add_env<T: Into<Env>>(self, new_env: T) -> Self

Adds an environment variable to the workflow.

pub fn add_env_when<T: Into<Env>>(self, cond: bool, new_env: T) -> Self

Adds an environment variable to the workflow when a condition is met.

pub fn get_id(&self, job: &Job) -> Option<&str>

Performs a reverse lookup to get the ID of a job.

Trait Implementations

impl Clone for Workflow

fn clone(&self) -> Workflow

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Workflow

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Workflow

fn default() -> Workflow

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Workflow

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Workflow

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.