refactor: many many changes

README.md

@@ -27,48 +27,13 @@ To use **Rust GitHub Workflows** in your project, add it to your `Cargo.toml`:
 gh-workflow = "0.1"
 ```
 
-Then you can start creating GitHub Actions in your [build.rs](https://github.com/tailcallhq/rust-gh-workflows/blob/main/workspace/gh-workflow-gen/build.rs).
-
-## 👷 Usage
-
-- Simply add a `build.rs` file to your project's root directory.
-- Add the following code to generate the GitHub Actions workflow:
-
-```rust
-  use rust_gh_workflows::*;
-
-  fn main() {
-      // Create a workflow
-      let workflow = Workflow::new("CI")
-          .permissions(Permissions::read())
-          .on(Event::default().push(Push::default().branch("main"))
-          .add_job(
-              "build",
-              Job::new("Build and Test")
-                  .add_step(Step::checkout())
-                  .add_step(Step::setup_rust().add_toolchain(Toolchain::Stable))
-                  .add_step(Step::cargo("test", vec!["--all-features", "--workspace"]))
-          )
-          .unwrap();
-
-      // Generate the ci.yml
-      workflow.generate().unwrap();
-  }
-  ```
+or via CLI
 
-  To view a fully functional example, check out the [build.rs](https://github.com/tailcallhq/rust-gh-workflows/blob/main/workspace/gh-workflow-gen/build.rs) of this project.
-
-- Run `cargo build` to generate the GitHub Actions workflow.
-
-**Workspace**
-
-- The `workspace` directory contains the `gh-workflow-gen` crate, which generates the workflow.
-
-## 🛠️ Roadmap
+```bash
+cargo add --build gh-workflow
+```
 
-- [ ] Support for Automated Cargo Releases
-- [ ] Improve Type Safety of Nightly Builds
-- [ ] Add Rust Docs for the API
+Then you can start creating GitHub Actions in your [build.rs](https://github.com/tailcallhq/rust-gh-workflows/blob/main/workspace/gh-workflow-gen/build.rs).
 
 ## 💡 Why Rust?
 

workspace/gh-workflow-gen/build.rs

@@ -1,9 +1,51 @@
-use gh_workflow::generate::Generate;
 use gh_workflow::*;
+use toolchain::Toolchain;
 
 fn main() {
-    Generate::new(Workflow::setup_rust())
-        .name("ci.yml")
+    let job = Job::new("Build and Test")
+        .add_step(Step::checkout())
+        .add_step(
+            Toolchain::default()
+                .add_stable()
+                .add_nightly()
+                .add_clippy()
+                .add_fmt(),
+        )
+        .add_step(
+            Cargo::new("test")
+                .args("--all-features --workspace")
+                .name("Cargo Test"),
+        )
+        .add_step(
+            Cargo::new("fmt")
+                .nightly()
+                .args("--check")
+                .name("Cargo Fmt"),
+        )
+        .add_step(
+            Cargo::new("clippy")
+                .nightly()
+                .args("--all-features --workspace -- -D warnings")
+                .name("Cargo Clippy"),
+        );
+
+    let event = Event::default()
+        .push(Push::default().add_branch("main"))
+        .pull_request_target(
+            PullRequestTarget::default()
+                .open()
+                .synchronize()
+                .reopen()
+                .add_branch("main"),
+        );
+
+    let flags = RustFlags::deny("warnings");
+
+    Workflow::new("Build and Test")
+        .env(flags)
+        .permissions(Permissions::read())
+        .on(event)
+        .add_job("build", job)
         .generate()
         .unwrap();
 }

workspace/gh-workflow/Cargo.toml

@@ -5,19 +5,20 @@ edition = "2021"
 
 description = "A type-safe GitHub Actions workflow generator"
 license = "Apache-2.0"
-documentation = "https://github.com/tailcallhq/rust-gh-workflows"
+documentation = "https://docs.rs/gh-workflow"
 homepage = "https://github.com/tailcallhq/rust-gh-workflows"
 repository = "https://github.com/tailcallhq/rust-gh-workflows"
 
 [dependencies]
 async-trait = "0.1.83"
-derive_more = { version = "1.0.0", features = ["from"] }
+derive_more = { version = "1.0.0", features = ["from", "deref", "deref_mut"] }
 derive_setters = "0.1.6"
 indexmap = { version = "2.6.0", features = ["serde"] }
 merge = "0.1.0"
 serde = { version = "1.0.210", features = ["derive"] }
 serde_json = { version = "1.0.128" }
 serde_yaml = "0.9.34"
+strum_macros = "0.26.4"
 
 [dev-dependencies]
 insta = "1.40.0"

workspace/gh-workflow/src/cargo.rs

@@ -0,0 +1,70 @@
+use derive_setters::Setters;
+
+use crate::toolchain::Version;
+use crate::StepValue;
+
+#[derive(Setters)]
+#[setters(strip_option, into)]
+pub struct Cargo {
+    /// The command to be executed for eg: fmt, clippy, build, test, etc.
+    pub command: String,
+
+    /// The unique identifier of the Step.
+    pub id: Option<String>,
+
+    /// Name of the Step
+    pub name: Option<String>,
+
+    /// Toolchain to be used for example `+nightly`.
+    pub toolchain: Option<Version>,
+
+    /// Arguments to be passed to the cargo command.
+    pub args: Option<String>,
+}
+
+impl Cargo {
+    pub fn new<T: ToString>(cmd: T) -> Cargo {
+        Cargo {
+            command: cmd.to_string(),
+            id: Default::default(),
+            name: Default::default(),
+            toolchain: Default::default(),
+            args: Default::default(),
+        }
+    }
+
+    pub fn nightly(mut self) -> Self {
+        self.toolchain = Some(Version::Nightly);
+        self
+    }
+}
+
+impl From<Cargo> for StepValue {
+    fn from(value: Cargo) -> Self {
+        let mut command = vec!["cargo".to_string()];
+
+        if let Some(toolchain) = value.toolchain {
+            command.push(format!("+{}", toolchain));
+        }
+
+        command.push(value.command);
+
+        if let Some(args) = value.args {
+            if !args.is_empty() {
+                command.push(args);
+            }
+        }
+
+        let mut step = StepValue::run(command.join(" "));
+
+        if let Some(id) = value.id {
+            step = step.id(id);
+        }
+
+        if let Some(name) = value.name {
+            step = step.name(name);
+        }
+
+        step
+    }
+}