Add get-changed-files action (#23)

Author: IlyaKhD

common/package.json

@@ -9,8 +9,7 @@
   "main": "lib/index.js",
   "scripts": {
     "clean": "rimraf lib",
-    "build": "tsc",
-    "test": "jest --config ../jest.config.js"
+    "build": "tsc"
   },
   "devDependencies": {
     "minimatch": "^10.0.1"

common/src/constants.ts

@@ -0,0 +1,10 @@
+
+export const inputs = {
+    GH_TOKEN: 'gh-token',
+    OUTPUT: 'output',
+    PATHS: 'paths',
+} as const;
+
+export const outputs = {
+    RESULT: 'result',
+} as const;

common/src/fs-utils.ts

@@ -0,0 +1,6 @@
+import { mkdirSync } from 'fs';
+import { dirname as getDirName } from 'path';
+
+export function ensureDir(path: string): void {
+    mkdirSync(getDirName(path), { recursive: true });
+}

common/src/index.ts

@@ -1,3 +1,5 @@
 export * from './common-utils';
+export * from './constants';
+export * from './fs-utils';
 export * from './path-utils';
 export * from './pr-utils';

common/src/path-utils.ts

@@ -1,3 +1,4 @@
+import * as core from '@actions/core'
 import { MinimatchOptions, minimatch } from "minimatch";
 
 const NEGATION = '!';
@@ -12,6 +13,16 @@ function match(path: string, pattern: string): boolean {
 export function filterPaths(
     paths: string[],
     patterns: string[],
+): string[] {
+    core.debug('patterns: ' + JSON.stringify(patterns, undefined, 2));
+    const filteredPaths = filterPathsImpl(paths, patterns);
+    core.info(`${filteredPaths.length} filtered paths: ${JSON.stringify(filteredPaths, undefined, 2)}`);
+    return filteredPaths;
+}
+
+function filterPathsImpl(
+    paths: string[],
+    patterns: string[],
 ): string[] {
     return paths.filter(path => {
         return patterns.reduce((prevResult, pattern) => {

common/src/pr-utils.ts

@@ -1,44 +1,72 @@
 
 import * as core from '@actions/core'
-import { context } from '@actions/github'
+import { context, getOctokit } from '@actions/github'
 import { execCommand } from './common-utils';
 
 export async function getPrRevisionRange(): Promise<{
     head: string;
     base: string;
 }> {
-    return getRange().then((r) => {
+    return getPrRevisionRangeImpl().then((r) => {
         core.info(`Base commit: ${r.base}`);
         core.info(`Head commit: ${r.head}`);
         return r;
     });
 }
 
-function normalizeCommit(commit: string) {
-    return commit === '0000000000000000000000000000000000000000' ? 'HEAD^' : commit;
-}
-
-export async function getRange(): Promise<{
+async function getPrRevisionRangeImpl(): Promise<{
     head: string;
     base: string;
 }> {
     switch (context.eventName) {
         case 'pull_request':
-            const baseBranch = context.payload.pull_request?.base?.ref;
-            await execCommand(`git fetch origin`);
+        const baseBranch = context.payload.pull_request?.base?.ref;
+        await execCommand(`git fetch origin`);
+        
+        return {
+            base: await execCommand(`git rev-parse origin/${baseBranch}`),
+            head: context.payload.pull_request?.head?.sha,
+        };
+        
+        case 'push':
+        
+        return {
+            base: normalizeCommit(context.payload.before),
+            head: context.payload.after,
+        };
+        default:
+        throw new Error(`This action only supports pull requests and pushes, ${context.eventName} events are not supported.`);
+    }
+}
+function normalizeCommit(commit: string) {
+    return commit === '0000000000000000000000000000000000000000' ? 'HEAD^' : commit;
+}
+
+export async function getChangedFiles(token: string): Promise<string[]> {
+    return getChangedFilesImpl(token).then((files) => {
+        core.info(`${files.length} changed files: ${JSON.stringify(files, undefined, 2)}`)
+        return files;
+    });
+}
 
-            return {
-                base: await execCommand(`git rev-parse origin/${baseBranch}`),
-                head: context.payload.pull_request?.head?.sha,
-            };
+async function getChangedFilesImpl(token: string): Promise<string[]> {
+    try {
+        const octokit = getOctokit(token);
 
-        case 'push':
+        if (context.payload.pull_request == null) {
+            core.setFailed('Getting changed files only works on pull request events.');
+            return [];
+        }
 
-            return {
-                base: normalizeCommit(context.payload.before),
-                head: context.payload.after,
-            };
-        default:
-            throw new Error(`This action only supports pull requests and pushes, ${context.eventName} events are not supported.`);
+        const files = await octokit.paginate(octokit.rest.pulls.listFiles, {
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            pull_number: context.payload.pull_request.number,
+        });
+
+        return files.map(file => file.filename);
+    } catch (error) {
+        core.setFailed(`Getting changed files failed with error: ${error}`);
+        return [];
     }
 }

get-changed-files/action.yml

@@ -0,0 +1,25 @@
+name: get-changed-files
+description: Filters the list of files changed in a PR with path globs and saves the list to file
+
+inputs:
+
+  gh-token:
+    description: GitHub access token (GITHUB_TOKEN)
+    required: true
+
+  paths:
+    description: Semicolon separated globs
+    required: false
+
+  output:
+    description: Output file path
+    required: true
+
+
+runs:
+  using: node16
+  main: dist/index.js
+
+outputs:
+  result:
+    description: A file with the list of files in JSON format