v4 (#5)

* Support path exclusion
Lightning-AI · Nov 13, 2022 · b074abe · b074abe
1 parent 0320389
commit b074abe
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 63 deletions.
diff --git a/dist/check-group/utils/subproj_matching.js b/dist/check-group/utils/subproj_matching.js
@@ -15,27 +15,19 @@ var minimatch_1 = __importDefault(require("minimatch"));
 var matchFilenamesToSubprojects = function (filenames, subprojConfigs) {
     var matchingSubProjs = [];
     subprojConfigs.forEach(function (subproj) {
-        var hasMatching = false;
-        var updatedSubProj = subproj;
-        var updatedPaths = [];
+        var hits = new Set();
         subproj.paths.forEach(function (path) {
-            var updatedPath = path;
-            if (!updatedPath.matches) {
-                updatedPath.matches = [];
-            }
-            filenames.forEach(function (filename) {
-                if ((0, minimatch_1.default)(filename, path.location)) {
-                    hasMatching = true;
-                    updatedPath.hit = true;
-                    if (updatedPath.matches) {
-                        updatedPath.matches.push(filename);
-                    }
-                }
-            });
-            updatedPaths.push(updatedPath);
+            // support for GitHub-style path exclusion
+            // https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-including-and-excluding-paths
+            var isNegation = path.startsWith("!");
+            // https://www.npmjs.com/package/minimatch
+            var matches = minimatch_1.default.match(filenames, path, { "flipNegate": isNegation });
+            // if it's a negation, delete from the list of hits, otherwise add
+            matches.forEach(function (match) { return (isNegation) ? hits.delete(match) : hits.add(match); });
         });
-        if (hasMatching) {
-            updatedSubProj.paths = updatedPaths;
+        if (hits.size) {
+            var updatedSubProj = subproj;
+            updatedSubProj.paths = Array.from(hits);
             matchingSubProjs.push(updatedSubProj);
         }
     });

diff --git a/dist/check-group/utils/user_config_parser/populate_subprojects.js b/dist/check-group/utils/user_config_parser/populate_subprojects.js
@@ -39,13 +39,7 @@ function parseProjectPaths(subprojData) {
     if (!("paths" in subprojData) || subprojData["paths"] == null) {
         core.setFailed("The list of paths for the '".concat(subprojData["id"], "' group is not defined"));
     }
-    var projPaths = [];
-    var locations = subprojData["paths"];
-    locations.forEach(function (loc) {
-        projPaths.push({
-            location: loc,
-        });
-    });
+    var projPaths = subprojData["paths"];
     if (projPaths.length == 0) {
         core.setFailed("The list of paths for the '".concat(subprojData["id"], "' group is empty"));
     }

diff --git a/src/check-group/types.ts b/src/check-group/types.ts
@@ -18,12 +18,6 @@ export interface ProgressReport {
   succeeded?: string[];
 }
 
-export interface SubProjPath {
-  location: string;
-  hit?: boolean;
-  matches?: string[];
-}
-
 export interface SubProjCheck {
   /**
    * The ID of the check which should
@@ -53,7 +47,7 @@ export interface SubProjConfig {
    * this sub-project within
    * the repository.
    */
-  paths: SubProjPath[];
+  paths: string[];
   /**
    * A list of check IDs that
    * are expected to pass for

diff --git a/src/check-group/utils/subproj_matching.ts b/src/check-group/utils/subproj_matching.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { SubProjConfig, SubProjPath } from "../types";
+import { SubProjConfig } from "../types";
 /* eslint-enable @typescript-eslint/no-unused-vars */
 import minimatch from "minimatch";
 
@@ -15,27 +15,19 @@ export const matchFilenamesToSubprojects = (
 ): SubProjConfig[] => {
   const matchingSubProjs: SubProjConfig[] = [];
   subprojConfigs.forEach((subproj) => {
-    let hasMatching = false;
-    const updatedSubProj = subproj;
-    const updatedPaths: SubProjPath[] = [];
-    subproj.paths.forEach((path) => {
-      const updatedPath = path;
-      if (!updatedPath.matches) {
-        updatedPath.matches = [];
-      }
-      filenames.forEach((filename) => {
-        if (minimatch(filename, path.location)) {
-          hasMatching = true;
-          updatedPath.hit = true;
-          if (updatedPath.matches) {
-            updatedPath.matches.push(filename);
-          }
-        }
-      });
-      updatedPaths.push(updatedPath);
+    const hits: Set<string> = new Set();
+    subproj.paths.forEach((path: string) => {
+      // support for GitHub-style path exclusion
+      // https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-including-and-excluding-paths
+      const isNegation = path.startsWith("!")
+      // https://www.npmjs.com/package/minimatch
+      const matches = minimatch.match(filenames, path, {"flipNegate": isNegation})
+      // if it's a negation, delete from the list of hits, otherwise add
+      matches.forEach((match: string) => (isNegation) ? hits.delete(match): hits.add(match))
     });
-    if (hasMatching) {
-      updatedSubProj.paths = updatedPaths;
+    if (hits.size) {
+      const updatedSubProj = subproj;
+      updatedSubProj.paths = Array.from(hits);
       matchingSubProjs.push(updatedSubProj);
     }
   });

diff --git a/src/check-group/utils/user_config_parser/populate_subprojects.ts b/src/check-group/utils/user_config_parser/populate_subprojects.ts
@@ -6,7 +6,6 @@ import {
   CheckGroupConfig,
   SubProjCheck,
   SubProjConfig,
-  SubProjPath,
 } from "../../types";
 import * as core from '@actions/core'
 
@@ -17,17 +16,11 @@ export function parseProjectId(subprojData: Record<string, unknown>): string {
   return subprojData["id"] as string;
 }
 
-export function parseProjectPaths(subprojData: Record<string, unknown>): SubProjPath[] {
+export function parseProjectPaths(subprojData: Record<string, unknown>): string[] {
   if (!("paths" in subprojData) || subprojData["paths"] == null) {
     core.setFailed(`The list of paths for the '${subprojData["id"]}' group is not defined`);
   }
-  const projPaths: SubProjPath[] = [];
-  const locations: string[] = subprojData["paths"] as string[];
-  locations.forEach((loc) => {
-    projPaths.push({
-      location: loc,
-    });
-  });
+  const projPaths: string[] = subprojData["paths"] as string[];
   if (projPaths.length == 0) {
     core.setFailed(`The list of paths for the '${subprojData["id"]}' group is empty`);
   }