Only report the first CheckoutWrongHead lint error

github · Dec 21, 2020 · e89a24b · e89a24b
1 parent dc999c5
commit e89a24b
Show file tree

Hide file tree

Showing 6 changed files with 50 additions and 4 deletions.
diff --git a/lib/actions-util.js b/lib/actions-util.js
diff --git a/lib/actions-util.js.map b/lib/actions-util.js.map
diff --git a/lib/actions-util.test.js b/lib/actions-util.test.js
diff --git a/lib/actions-util.test.js.map b/lib/actions-util.test.js.map
diff --git a/src/actions-util.test.ts b/src/actions-util.test.ts
@@ -432,3 +432,27 @@ on:
 
   t.deepEqual(errors, []);
 });
+
+test("validateWorkflow() should only report the first CheckoutWrongHead", (t) => {
+  const errors = actionsutil.validateWorkflow(
+    yaml.safeLoad(`
+name: "CodeQL"
+on:
+  push:
+    branches: [master]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [master]
+jobs:
+  test:
+    steps:
+      - run: "git checkout HEAD^2"
+      - run: "git checkout HEAD^2"
+      - run: "git checkout HEAD^2"
+      - run: "git checkout HEAD^2"
+      - run: "git checkout HEAD^2"
+`)
+  );
+
+  t.deepEqual(errors, [actionsutil.WorkflowErrors.CheckoutWrongHead]);
+});
diff --git a/src/actions-util.ts b/src/actions-util.ts
@@ -212,7 +212,7 @@ export function validateWorkflow(doc: Workflow): CodedError[] {
   const errors: CodedError[] = [];
 
   // .jobs[key].steps[].run
-  for (const job of Object.values(doc?.jobs || {})) {
+  outer: for (const job of Object.values(doc?.jobs || {})) {
     if (Array.isArray(job?.steps)) {
       for (const step of job?.steps) {
         // this was advice that we used to give in the README
@@ -222,6 +222,7 @@ export function validateWorkflow(doc: Workflow): CodedError[] {
         // and avoid some race conditions
         if (step?.run === "git checkout HEAD^2") {
           errors.push(WorkflowErrors.CheckoutWrongHead);
+          break outer;
         }
       }
     }