Struct StandardWorkflow

pub struct StandardWorkflow {
    pub auto_release: bool,
    pub name: String,
    pub benchmarks: bool,
    pub auto_fix: bool,
    pub setup: Vec<Step<Run>>,
    pub test_runner: TestRunner,
}

Fields

auto_release: bool

When enabled, a release job is added to the workflow. IMPORTANT: Ensure secrets.CARGO_REGISTRY_TOKEN is set for your github action.

name: String

Name of the workflow.

benchmarks: bool

When enabled, a benchmark job is added to the workflow.

auto_fix: bool

Auto-fixes the code after

setup: Vec<Step<Run>>

Steps to be executed before the checkout step

test_runner: TestRunner

The test runner to use for running tests

Implementations

impl StandardWorkflow

pub fn auto_release(self, value: bool) -> Self

Sets the auto_release field of this struct.

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

Sets the name field of this struct.

pub fn benchmarks(self, value: bool) -> Self

Sets the benchmarks field of this struct.

pub fn auto_fix(self, value: bool) -> Self

Sets the auto_fix field of this struct.

pub fn setup(self, value: Vec<Step<Run>>) -> Self

Sets the setup field of this struct.

pub fn test_runner(self, value: TestRunner) -> Self

Sets the test_runner field of this struct.

impl StandardWorkflow

pub fn add_setup<S: Into<Step<Run>>>(self, step: S) -> Self

Add a setup step to be executed before the checkout step.

Example

use gh_workflow_tailcall::*;
let workflow = StandardWorkflow::default()
    .add_setup(Step::run("git config --global core.autocrlf false")
        .name("Configure git"));

impl StandardWorkflow

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

Generates and tests the workflow file.

pub fn to_ci_workflow(&self) -> GHWorkflow

Converts the workflow into a Github workflow.

Trait Implementations

impl Clone for StandardWorkflow

fn clone(&self) -> StandardWorkflow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StandardWorkflow

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

Formats the value using the given formatter.

impl Default for StandardWorkflow

fn default() -> Self

Returns the “default value” for a type.