Move render and pr-check into a Cargo workspace

Adds data/Cargo.toml as a workspace root so both crates share a single
target directory and a common set of dependency versions via
[workspace.dependencies].

pr-check now depends on the render crate directly and uses
render::types::ParsedEntry instead of its own ToolEntry struct,
removing the duplication. The Makefile and pr-check workflow are
updated to target the workspace manifest. The gitignore entry is
updated from data/pr-check/target/ to data/target/.

Author: mre

.github/workflows/pr-check.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
     branches: [master]
     paths:
-      - 'data/tools/**.yml'
+      - "data/tools/**.yml"
 
 jobs:
   pr-check:
@@ -32,18 +32,18 @@ jobs:
           path: |
             ~/.cargo/registry
             ~/.cargo/git
-            data/pr-check/target
-          key: pr-check-${{ runner.os }}-${{ hashFiles('data/pr-check/Cargo.lock') }}
+            data/target
+          key: pr-check-${{ runner.os }}-${{ hashFiles('data/Cargo.lock') }}
           restore-keys: |
             pr-check-${{ runner.os }}-
 
       - name: Build pr-check
-        run: cargo build --release --manifest-path data/pr-check/Cargo.toml
+        run: cargo build --release --manifest-path data/Cargo.toml -p pr-check
 
       - name: Run pr-check
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           GITHUB_REPOSITORY: ${{ github.repository }}
           PR_NUMBER: ${{ github.event.pull_request.number }}
         run: |
-          data/pr-check/target/release/pr-check ${{ steps.changed.outputs.files }}
+          data/target/release/pr-check ${{ steps.changed.outputs.files }}

.gitignore

@@ -1,3 +1,3 @@
 logcli-linux-amd64
 logcli.zip
-data/pr-check/target/
+data/target/

Makefile

@@ -16,23 +16,23 @@ help:
 
 # Main rendering targets
 render:
-	cargo run --manifest-path data/render/Cargo.toml -- --tags data/tags.yml --tools data/tools --md-out README.md --json-out data/api
+	cargo run --manifest-path data/Cargo.toml -p render -- --tags data/tags.yml --tools data/tools --md-out README.md --json-out data/api
 
 render-skip-deprecated:
-	cargo run --manifest-path data/render/Cargo.toml -- --tags data/tags.yml --tools data/tools --md-out README.md --json-out data/api --skip-deprecated
+	cargo run --manifest-path data/Cargo.toml -p render -- --tags data/tags.yml --tools data/tools --md-out README.md --json-out data/api --skip-deprecated
 
 # Development targets
 check:
-	cargo check --manifest-path data/render/Cargo.toml
+	cargo check --manifest-path data/Cargo.toml
 
 clippy:
-	cargo clippy --manifest-path data/render/Cargo.toml -- -D warnings
+	cargo clippy --manifest-path data/Cargo.toml -- -D warnings
 
 fmt:
-	cargo fmt --manifest-path data/render/Cargo.toml
+	cargo fmt --manifest-path data/Cargo.toml
 
 test:
-	cargo test --manifest-path data/render/Cargo.toml
+	cargo test --manifest-path data/Cargo.toml
 
 clean:
-	cargo clean --manifest-path data/render/Cargo.toml
+	cargo clean --manifest-path data/Cargo.toml

data/Cargo.toml

@@ -0,0 +1,16 @@
+[workspace]
+members = [
+    "render",
+    "pr-check",
+]
+resolver = "2"
+
+[workspace.dependencies]
+anyhow = "1.0"
+chrono = { version = "0.4", features = ["serde"] }
+pico-args = "0.5"
+serde = { version = "1.0", features = ["derive"] }
+serde_derive = "1.0"
+serde_json = "1.0"
+serde_yaml = "0.9"
+tokio = { version = "1", features = ["rt-multi-thread", "macros"] }

data/pr-check/Cargo.toml

@@ -5,6 +5,7 @@ edition = "2024"
 description = "Checks pull requests against contributing criteria"
 license = "MIT"
 repository = "https://github.com/analysis-tools-dev/static-analysis"
+publish = false
 
 [lints.clippy]
 correctness = { level = "deny", priority = -1 }
@@ -32,11 +33,12 @@ similar_names = "allow"
 too_many_lines = "allow"
 
 [dependencies]
-anyhow = "1.0"
-chrono = { version = "0.4", features = ["serde"] }
-pico-args = "0.5"
-reqwest = { version = "0.12", features = ["json", "rustls-tls"], default-features = false }
-serde = { version = "1.0", features = ["derive"] }
-serde_yaml = "0.9"
-serde_json = "1.0"
-tokio = { version = "1", features = ["rt-multi-thread", "macros"] }
+render = { path = "../render" }
+anyhow = { workspace = true }
+chrono = { workspace = true }
+pico-args = { workspace = true }
+serde = { workspace = true }
+serde_json = { workspace = true }
+serde_yaml = { workspace = true }
+tokio = { workspace = true }
+reqwest = { version = "0.12", features = ["json", "rustls-tls"], default-features = false }

data/pr-check/src/main.rs

@@ -20,18 +20,12 @@
 
 use anyhow::{Context, Result, bail};
 use chrono::{DateTime, Duration, Utc};
+use render::types::ParsedEntry;
 use serde::Deserialize;
 use std::collections::HashMap;
 use std::env;
 use std::path::{Path, PathBuf};
 
-/// A parsed tool entry from `data/tools/<name>.yml`.
-#[derive(Debug, Deserialize)]
-struct ToolEntry {
-    name: String,
-    source: Option<String>,
-}
-
 /// Response from `GET /repos/{owner}/{repo}`.
 #[derive(Debug, Deserialize)]
 struct RepoInfo {
@@ -187,8 +181,7 @@ impl GithubClient {
     ///
     /// Returns an error if the API call fails.
     async fn list_pr_comments(&self, repo: &str, pr: u64) -> Result<Vec<IssueComment>> {
-        let url =
-            format!("https://api.github.com/repos/{repo}/issues/{pr}/comments?per_page=100");
+        let url = format!("https://api.github.com/repos/{repo}/issues/{pr}/comments?per_page=100");
         self.get::<Vec<IssueComment>>(&url).await
     }
 
@@ -276,7 +269,7 @@ fn parse_github_repo(url: &str) -> Option<(String, String)> {
 /// # Errors
 ///
 /// Returns an error if the file cannot be read or parsed.
-fn read_tool(path: &Path) -> Result<ToolEntry> {
+fn read_tool(path: &Path) -> Result<ParsedEntry> {
     let f = std::fs::File::open(path).with_context(|| format!("Cannot open {}", path.display()))?;
     serde_yaml::from_reader(f).with_context(|| format!("Cannot parse {}", path.display()))
 }
@@ -287,7 +280,7 @@ fn read_tool(path: &Path) -> Result<ToolEntry> {
 ///
 /// Returns an error only for unexpected failures (network, auth). Missing
 /// criteria produce `CheckResult::Fail` values, not errors.
-async fn check_tool(client: &GithubClient, tool: &ToolEntry) -> Result<ToolReport> {
+async fn check_tool(client: &GithubClient, tool: &ParsedEntry) -> Result<ToolReport> {
     let source = tool.source.clone();
 
     let gh_coords = source.as_deref().and_then(parse_github_repo);
@@ -302,9 +295,7 @@ async fn check_tool(client: &GithubClient, tool: &ToolEntry) -> Result<ToolRepor
                 if s >= MIN_STARS {
                     CheckResult::Pass(format!("{s} stars"))
                 } else {
-                    CheckResult::Fail(format!(
-                        "{s} stars (minimum is {MIN_STARS})"
-                    ))
+                    CheckResult::Fail(format!("{s} stars (minimum is {MIN_STARS})"))
                 }
             }
             Err(e) => CheckResult::Fail(format!("Could not fetch repo info: {e}")),
@@ -341,7 +332,7 @@ async fn check_tool(client: &GithubClient, tool: &ToolEntry) -> Result<ToolRepor
         };
 
         Ok(ToolReport {
-            name: tool.name.clone(),
+            name: tool.name.to_string(),
             source,
             stars: stars_check,
             contributors: contributors_check,
@@ -357,7 +348,7 @@ async fn check_tool(client: &GithubClient, tool: &ToolEntry) -> Result<ToolRepor
         };
 
         Ok(ToolReport {
-            name: tool.name.clone(),
+            name: tool.name.to_string(),
             source,
             stars: CheckResult::Skip("N/A (non-GitHub source)".into()),
             contributors: CheckResult::Skip("N/A (non-GitHub source)".into()),
@@ -432,12 +423,7 @@ fn render_comment(reports: &[ToolReport]) -> String {
 /// # Errors
 ///
 /// Returns an error if the GitHub API calls fail.
-async fn upsert_comment(
-    client: &GithubClient,
-    repo: &str,
-    pr: u64,
-    body: &str,
-) -> Result<()> {
+async fn upsert_comment(client: &GithubClient, repo: &str, pr: u64, body: &str) -> Result<()> {
     let comments = client.list_pr_comments(repo, pr).await?;
 
     let existing = comments.iter().find(|c| c.body.contains(COMMENT_MARKER));
@@ -462,8 +448,7 @@ fn parse_pr_number(s: &str) -> Result<u64> {
 #[tokio::main]
 async fn main() -> Result<()> {
     let token = env::var("GITHUB_TOKEN").context("GITHUB_TOKEN not set")?;
-    let gh_repo =
-        env::var("GITHUB_REPOSITORY").context("GITHUB_REPOSITORY not set")?;
+    let gh_repo = env::var("GITHUB_REPOSITORY").context("GITHUB_REPOSITORY not set")?;
     let pr_number_str = env::var("PR_NUMBER").context("PR_NUMBER not set")?;
     let pr_number = parse_pr_number(&pr_number_str)?;
 
@@ -475,18 +460,16 @@ async fn main() -> Result<()> {
     let tool_paths: Vec<PathBuf> = tool_paths
         .into_iter()
         .filter(|p| {
-            p.starts_with("data/tools")
-                && p.extension().and_then(|e| e.to_str()) == Some("yml")
+            p.starts_with("data/tools") && p.extension().and_then(|e| e.to_str()) == Some("yml")
         })
         .collect();
 
     let client = GithubClient::new(token)?;
 
     let mut reports = Vec::new();
     for path in &tool_paths {
-        let tool = read_tool(path)
-            .with_context(|| format!("Failed to read {}", path.display()))?;
-        eprintln!("Checking '{}'...", tool.name);
+        let tool = read_tool(path).with_context(|| format!("Failed to read {}", path.display()))?;
+        eprintln!("Checking '{}'...", &tool.name);
         let report = check_tool(&client, &tool).await?;
         reports.push(report);
     }
@@ -549,4 +532,4 @@ mod tests {
         let comment = render_comment(&[]);
         assert!(comment.contains(COMMENT_MARKER));
     }
-}
+}

data/render/Cargo.toml

@@ -8,6 +8,7 @@ license = "MIT"
 repository = "https://github.com/analysis-tools-dev/static-analysis"
 keywords = ["static-analysis", "linting", "tools", "catalog"]
 categories = ["development-tools"]
+publish = false
 
 [lints.clippy]
 # Correctness lints (enabled by default, but being explicit)
@@ -44,16 +45,16 @@ similar_names = "allow"
 too_many_lines = "allow"  # We'll use the clippy.toml threshold instead
 
 [dependencies]
-serde = "1.0.228"
-serde_derive = "1.0.136"
-serde_yaml = "0.9.34"
+anyhow = { workspace = true }
+chrono = { workspace = true }
+pico-args = { workspace = true }
+serde = { workspace = true }
+serde_derive = { workspace = true }
+serde_json = { workspace = true }
+serde_yaml = { workspace = true }
+tokio = { workspace = true }
 askama = "0.12.1"
 # Switch back to crates as soon as a new release with tokio 1.x support is
 # released. See https://github.com/softprops/hubcaps/pull/285
 hubcaps = { git="https://github.com/softprops/hubcaps" }
-tokio = { version = "1.43.4", features = ["rt-multi-thread", "macros"] }
-chrono = "0.4.44"
-anyhow = "1.0.102"
-pico-args = "0.5.0"
-serde_json = "1.0.149"
 slug = "0.1.6"