chore(ci): validate workflows as part of builds (#210)

hashicorp · Aug 28, 2024 · 8e5e6ff · 8e5e6ff
1 parent 16cdfbe
commit 8e5e6ff
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 2 deletions.
diff --git a/.projen/deps.json b/.projen/deps.json
diff --git a/.projen/tasks.json b/.projen/tasks.json
diff --git a/package.json b/package.json
diff --git a/projenrc/index.ts b/projenrc/index.ts
@@ -119,6 +119,8 @@ export class TerraformCdkActionProject extends GitHubActionTypeScriptProject {
         "projen-github-action-typescript@^0.0.395",
         "@types/fs-extra",
         "action-docs",
+        "@action-validator/core",
+        "@action-validator/cli",
       ],
       peerDeps: ["constructs@^10.0.0"],
       minNodeVersion: "20.9.0",
@@ -175,6 +177,13 @@ import * as core from "@actions/core";`,
       { name: "Add headers using Copywrite tool", run: "copywrite headers" }
     );
 
+    const validateTask = this.addTask("validate-workflows", {
+      exec: `find ./.github/workflows -type f -name "*.yml" -print0 | xargs -0 -n 1 npx action-validator`,
+    });
+    validateTask.description =
+      "Lint the YAML files generated by Projen to define GitHub Actions and Workflows, checking them against published JSON schemas";
+    this.postCompileTask.spawn(validateTask);
+
     // Add a step to notify Slack after a successful release
     // This is because we can't automate updating the Marketplace, sadly
     this.release?.addJobs({

diff --git a/yarn.lock b/yarn.lock