feat(generate-paths-matrix): allow glob to override filter (#40)

* feat(generate-path-matrix): add filtering by glob

* fix: updated logic

Co-authored-by: spincsak <[email protected]>

action.yml

@@ -22,7 +22,7 @@ inputs:
   note:
     description: 'The body text that should be added into a Project Card'
     required: false
-  project_origin_column_name: 
+  project_origin_column_name:
     description: 'The name of the column from where the card should be taken'
     required: false
   sha:
@@ -94,6 +94,9 @@ inputs:
   globs:
     description: 'A list of file paths (newline/comma separated) using glob syntax'
     required: false
+  override_filter_globs:
+    description: 'A list of file paths in glob syntax (newline/comma separated) that is used to override the filter'
+    required: false
 outputs:
   output:
     description: 'The output of the helper'

dist/action.yml

@@ -22,7 +22,7 @@ inputs:
   note:
     description: 'The body text that should be added into a Project Card'
     required: false
-  project_origin_column_name: 
+  project_origin_column_name:
     description: 'The name of the column from where the card should be taken'
     required: false
   sha:
@@ -94,6 +94,9 @@ inputs:
   globs:
     description: 'A list of file paths (newline/comma separated) using glob syntax'
     required: false
+  override_filter_globs:
+    description: 'A list of file paths in glob syntax (newline/comma separated) that is used to override the filter'
+    required: false
 outputs:
   output:
     description: 'The output of the helper'

dist/index.js

@@ -18871,11 +18871,13 @@ var map = {
 	"./generate-path-matrix": [
 		2533,
 		438,
+		228,
 		533
 	],
 	"./generate-path-matrix.ts": [
 		2533,
 		438,
+		228,
 		533
 	],
 	"./get-changed-files": [

src/helpers/generate-path-matrix.ts

@@ -13,18 +13,32 @@ limitations under the License.
 
 import { chunk } from 'lodash';
 import { getChangedFilepaths } from '../utils/get-changed-filepaths';
+import micromatch from 'micromatch';
 
 interface GeneratePathMatrix {
   pull_number: string;
   paths: string;
   override_filter_paths?: string;
+  override_filter_globs?: string;
   paths_no_filter?: string;
   batches?: string;
 }
 
-export const generatePathMatrix = async ({ pull_number, paths, override_filter_paths, paths_no_filter, batches }: GeneratePathMatrix) => {
+export const generatePathMatrix = async ({
+  pull_number,
+  paths,
+  override_filter_paths,
+  override_filter_globs,
+  paths_no_filter,
+  batches
+}: GeneratePathMatrix) => {
   const changedFiles = await getChangedFilepaths(pull_number);
-  const shouldOverrideFilter = changedFiles.some(changedFile => override_filter_paths?.split(/[\n,]/).includes(changedFile));
+  let shouldOverrideFilter: boolean;
+  if (override_filter_globs) {
+    shouldOverrideFilter = micromatch(changedFiles, override_filter_globs.split('\n')).length > 0;
+  } else {
+    shouldOverrideFilter = changedFiles.some(changedFile => override_filter_paths?.split(/[\n,]/).includes(changedFile));
+  }
   const splitPaths = paths.split(/[\n,]/);
   const matrixValues = shouldOverrideFilter
     ? splitPaths

test/helpers/generate-path-matrix.test.ts

@@ -127,6 +127,44 @@ describe('generatePathMatrix', () => {
     });
   });
 
+  describe('override filter globs case', () => {
+    const override_filter_globs = 'package.json\ntotally/crazy';
+
+    it('should call listFiles with correct params', async () => {
+      await generatePathMatrix({
+        paths,
+        pull_number,
+        override_filter_globs
+      });
+      expect(octokit.pulls.listFiles).toHaveBeenCalledWith({
+        pull_number: 123,
+        per_page: 100,
+        ...context.repo
+      });
+    });
+
+    it('should return expected result', async () => {
+      const result = await generatePathMatrix({
+        paths,
+        pull_number,
+        override_filter_globs
+      });
+      expect(result).toEqual({
+        include: [
+          {
+            path: filePath1
+          },
+          {
+            path: filePath2
+          },
+          {
+            path: filePath3
+          }
+        ]
+      });
+    });
+  });
+
   describe('additional no-filter paths case', () => {
     const extraPath = 'an/extra/path';