update toolchain

.github/workflows/ci.yml

@@ -13,16 +13,19 @@ on:
 permissions:
   contents: read
 jobs:
-  test:
-    name: Run tests
+  rust:
+    name: Rust Job
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout code
+    - name: Checkout Code
       uses: actions/checkout@v4
-    - name: Setup rust
+    - name: Setup Rust Toolchain
       uses: actions-rust-lang/setup-rust-toolchain@v1
       with:
         toolchain: stable
-    - name: Run tests
+    - name: Run Cargo Test
       run: RUSTFLAGS="-Awarnings" cargo test --all-features --workspace
-    timeout-minutes: 10
+    - name: Check Formatting
+      run: cargo fmt -- --check
+    - name: Run Clippy
+      run: cargo clippy -- -D warnings

.vscode/settings.json

@@ -1,3 +1,8 @@
 {
-  "cSpell.words": ["Gollum", "quicktype", "rustfmt"]
+  "cSpell.words": [
+    "Awarnings",
+    "Gollum",
+    "quicktype",
+    "rustfmt"
+  ]
 }

workspace/gh-workflow-gen/build.rs

@@ -1,7 +1,10 @@
 use gh_workflow::toolchain::RustToolchain;
 
 fn main() {
-    let toolchain = RustToolchain::default();
+    let toolchain = RustToolchain::default()
+        .workspace(true)
+        .fmt(true)
+        .clippy(true);
     toolchain
         .to_workflow()
         .unwrap()

workspace/gh-workflow/Cargo.toml

@@ -5,6 +5,7 @@ edition = "2021"
 
 [dependencies]
 async-trait = "0.1.83"
+convert_case = "0.6.0"
 derive_more = { version = "1.0.0", features = ["from"] }
 derive_setters = "0.1.6"
 indexmap = {version = "2.6.0", features = ["serde"]}

workspace/gh-workflow/src/toolchain.rs

@@ -9,7 +9,7 @@ use crate::workflow::*;
 /// A type-safe representation of the Rust toolchain.
 /// Instead of writing the github action for Rust by hand, we can use this
 /// struct to generate the github action.
-#[derive(Default)]
+#[derive(Default, Clone)]
 pub enum Version {
     #[default]
     Stable,
@@ -27,30 +27,53 @@ impl ToString for Version {
     }
 }
 
-#[derive(Setters, Default)]
+#[derive(Setters, Default, Clone)]
+#[setters(strip_option)]
 pub struct RustToolchain {
     version: Version,
     fmt: bool,
     clippy: bool,
-    // TODO: add more rust tool chain components
+    timeout: Option<Duration>,
+    workspace: bool,
 }
 
 impl RustToolchain {
     pub fn to_workflow(&self) -> Result<Workflow> {
-        let job = Job::new("Run tests")
+        let mut job = Job::new("Rust Job")
             .runs_on("ubuntu-latest")
-            .timeout(Duration::from_secs(10 * 60))
-            .add_step(Step::uses("actions", "checkout", 4).name("Checkout code"))
+            .add_step(Step::uses("actions", "checkout", 4).name("Checkout Code"))
             .add_step(
                 Step::uses("actions-rust-lang", "setup-rust-toolchain", 1)
-                    .name("Setup rust")
-                    .with(("toolchain", "stable")),
-            )
-            .add_step(
-                Step::run("RUSTFLAGS=\"-Awarnings\" cargo test --all-features --workspace")
-                    .name("Run tests"),
+                    .name("Setup Rust Toolchain")
+                    .with(("toolchain", self.version.clone())),
             );
 
+        if let Some(timeout) = self.timeout {
+            job = job.timeout(timeout);
+        }
+
+        let mut cargo_test_args = vec!["--all-features"];
+
+        if self.workspace {
+            cargo_test_args.push("--workspace");
+        }
+
+        job = job.add_step(
+            Step::run(format!(
+                "RUSTFLAGS=\"-Awarnings\" cargo test {}",
+                cargo_test_args.join(" ")
+            ))
+            .name("Run Cargo Test"),
+        );
+
+        if self.fmt {
+            job = job.add_step(Step::run("cargo fmt -- --check").name("Check formatting"));
+        }
+
+        if self.clippy {
+            job = job.add_step(Step::run("cargo clippy -- -D warnings").name("Run clippy"));
+        }
+
         Workflow::new("CI")
             .permissions(Permissions::read())
             .on(vec![
@@ -64,6 +87,6 @@ impl RustToolchain {
                     ],
                 ),
             ])
-            .add_job("test", job)
+            .add_job("rust", job)
     }
 }

workspace/gh-workflow/src/workflow.rs

@@ -1,5 +1,6 @@
 use std::{path::Path, time::Duration};
 
+use convert_case::{Case, Casing};
 use derive_setters::Setters;
 use indexmap::IndexMap;
 use serde::{Deserialize, Serialize};
@@ -86,10 +87,7 @@ pub struct EventAction {
 
 impl Workflow {
     pub fn new<T: ToString>(name: T) -> Self {
-        Self {
-            name: Some(name.to_string()),
-            ..Default::default()
-        }
+        Self { name: Some(name.to_string()), ..Default::default() }
     }
     pub fn to_string(&self) -> Result<String> {
         Ok(serde_yaml::to_string(self)?)
@@ -365,7 +363,7 @@ pub struct Step<T> {
 
 impl<T> Step<T> {
     pub fn name<S: ToString>(mut self, name: S) -> Self {
-        self.name = Some(name.to_string());
+        self.name = Some(name.to_string().to_case(Case::Title));
         self
     }
 }
@@ -447,8 +445,8 @@ pub trait Apply<Value> {
     fn apply(self, value: Value) -> Value;
 }
 
-impl<Ty, S: ToString> Apply<Step<Ty>> for (S, S) {
-    fn apply(self, mut step: Step<Ty>) -> Step<Ty> {
+impl<S1: ToString, S2: ToString> Apply<Step<Use>> for (S1, S2) {
+    fn apply(self, mut step: Step<Use>) -> Step<Use> {
         let mut index_map: IndexMap<String, Value> = step.with.unwrap_or_default();
         index_map.insert(self.0.to_string(), Value::String(self.1.to_string()));
         step.with = Some(index_map);