Struct Generator

Source

pub struct Generator { /* private fields */ }

Expand description

Builder for a CI workflow document.

§Example

use dev_ci::{Generator, Target};

let g = Generator::new().target(Target::GitHubActions);
assert_eq!(g.target_kind(), Target::GitHubActions);

Implementations§

Source §

impl Generator

Source

pub fn new() -> Self

Begin a new generator with default settings.

Examples found in repository ?

examples/basic.rs (line 8)

7fn main() {
8    let yaml = Generator::new()
9        .target(Target::GitHubActions)
10        .with_clippy()
11        .with_fmt()
12        .with_msrv("1.85")
13        .generate();
14
15    println!("{yaml}");
16}

Source

pub fn target(self, target: Target) -> Self

Select the target CI platform.

Examples found in repository ?

examples/basic.rs (line 9)

7fn main() {
8    let yaml = Generator::new()
9        .target(Target::GitHubActions)
10        .with_clippy()
11        .with_fmt()
12        .with_msrv("1.85")
13        .generate();
14
15    println!("{yaml}");
16}

Source

pub fn with_clippy(self) -> Self

Include a Clippy job.

Examples found in repository ?

examples/basic.rs (line 10)

7fn main() {
8    let yaml = Generator::new()
9        .target(Target::GitHubActions)
10        .with_clippy()
11        .with_fmt()
12        .with_msrv("1.85")
13        .generate();
14
15    println!("{yaml}");
16}

Source

pub fn with_fmt(self) -> Self

Include a rustfmt check job.

Examples found in repository ?

examples/basic.rs (line 11)

7fn main() {
8    let yaml = Generator::new()
9        .target(Target::GitHubActions)
10        .with_clippy()
11        .with_fmt()
12        .with_msrv("1.85")
13        .generate();
14
15    println!("{yaml}");
16}

Source

pub fn with_msrv(self, version: impl Into<String>) -> Self

Include an MSRV verification job pinned to the given Rust version.

Examples found in repository ?

examples/basic.rs (line 12)

7fn main() {
8    let yaml = Generator::new()
9        .target(Target::GitHubActions)
10        .with_clippy()
11        .with_fmt()
12        .with_msrv("1.85")
13        .generate();
14
15    println!("{yaml}");
16}

Source

pub fn target_kind(&self) -> Target

Selected target.

Source

pub fn generate(&self) -> String

Render the workflow document.

Examples found in repository ?

examples/basic.rs (line 13)

7fn main() {
8    let yaml = Generator::new()
9        .target(Target::GitHubActions)
10        .with_clippy()
11        .with_fmt()
12        .with_msrv("1.85")
13        .generate();
14
15    println!("{yaml}");
16}