feat: add allow-override-on-pr input

* chore: fix GitHub spelling in logs

* fix: rebuild dist

---------

Co-authored-by: Sascha Bratton <sascha@queen.one>

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v4.1.0
+- [Allow base/ref override on pull_request events](https://github.com/dorny/paths-filter/pull/NNN)
+
 ## v4.0.0
 - [Update action runtime to node24](https://github.com/dorny/paths-filter/pull/294)
 

README.md

@@ -117,7 +117,7 @@ For more information, see [CHANGELOG](https://github.com/dorny/paths-filter/blob
     # introduced by the current branch are considered.
     # All files are considered as added if there is no common ancestor with
     # base branch or no previous commit.
-    # This option is ignored if action is triggered by pull_request event.
+    # This option is ignored if action is triggered by pull_request event, unless 'allow-override-on-pr' is set to true.
     # Default: repository default branch (e.g. master)
     base: ''
 
@@ -126,7 +126,7 @@ For more information, see [CHANGELOG](https://github.com/dorny/paths-filter/blob
     # but you want to get changes on a different branch.
     # If this is empty and action is triggered by merge_group event,
     # the head commit in the event will be used.
-    # This option is ignored if action is triggered by pull_request event.
+    # This option is ignored if action is triggered by pull_request event, unless 'allow-override-on-pr' is set to true.
     # default: ${{ github.ref }}
     ref:
 
@@ -178,6 +178,14 @@ For more information, see [CHANGELOG](https://github.com/dorny/paths-filter/blob
     #  - '!**/*.jpeg'
     #  - '!**/*.md'
     predicate-quantifier: 'some'
+
+    # When true, the user-provided `base` and/or `ref` inputs are honored even if
+    # the action is triggered by a pull_request, pull_request_review,
+    # pull_request_review_comment, or pull_request_target event. In that case the
+    # action skips the GitHub API path and uses git diff against the provided
+    # base/ref. Has no effect if `base` and `ref` are both empty.
+    # Default: false
+    allow-override-on-pr: 'false'
 ```
 
 ## Outputs

action.yml

@@ -49,6 +49,14 @@ inputs:
       allows to override the "at least one pattern" behavior to make it so that all of the patterns have to match or otherwise the file is excluded.
     required: false
     default: 'some'
+  allow-override-on-pr:
+    description: |
+      When true, the user-provided `base` and/or `ref` inputs are honored even if the action
+      is triggered by a pull_request, pull_request_review, pull_request_review_comment, or
+      pull_request_target event. In that case the action skips the GitHub API path and uses
+      git diff against the provided base/ref. Has no effect if `base` and `ref` are both empty.
+    required: false
+    default: 'false'
 outputs:
   changes:
     description: JSON array with names of all filters matching any of changed files

dist/index.js

@@ -42,29 +42,18 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.Filter = exports.SUPPORTED_PREDICATE_QUANTIFIERS = exports.PredicateQuantifier = void 0;
-exports.isPredicateQuantifier = isPredicateQuantifier;
+exports.Filter = exports.isPredicateQuantifier = exports.SUPPORTED_PREDICATE_QUANTIFIERS = exports.PredicateQuantifier = void 0;
 const jsyaml = __importStar(__nccwpck_require__(1917));
 const picomatch_1 = __importDefault(__nccwpck_require__(8569));
 // Minimatch options used in all matchers
@@ -106,6 +95,7 @@ exports.SUPPORTED_PREDICATE_QUANTIFIERS = Object.values(PredicateQuantifier);
 function isPredicateQuantifier(x) {
     return exports.SUPPORTED_PREDICATE_QUANTIFIERS.includes(x);
 }
+exports.isPredicateQuantifier = isPredicateQuantifier;
 class Filter {
     // Creates instance of Filter and load rules from YAML if it's provided
     constructor(yaml, filterConfig) {
@@ -206,34 +196,15 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.HEAD = exports.NULL_SHA = void 0;
-exports.getChangesInLastCommit = getChangesInLastCommit;
-exports.getChanges = getChanges;
-exports.getChangesOnHead = getChangesOnHead;
-exports.getChangesSinceMergeBase = getChangesSinceMergeBase;
-exports.parseGitDiffOutput = parseGitDiffOutput;
-exports.listAllFilesAsAdded = listAllFilesAsAdded;
-exports.getCurrentRef = getCurrentRef;
-exports.getShortName = getShortName;
-exports.isGitSha = isGitSha;
+exports.isGitSha = exports.getShortName = exports.getCurrentRef = exports.listAllFilesAsAdded = exports.parseGitDiffOutput = exports.getChangesSinceMergeBase = exports.getChangesOnHead = exports.getChanges = exports.getChangesInLastCommit = exports.HEAD = exports.NULL_SHA = void 0;
 const exec_1 = __nccwpck_require__(1514);
 const core = __importStar(__nccwpck_require__(2186));
 const file_1 = __nccwpck_require__(4014);
@@ -251,6 +222,7 @@ async function getChangesInLastCommit() {
     }
     return parseGitDiffOutput(output);
 }
+exports.getChangesInLastCommit = getChangesInLastCommit;
 async function getChanges(base, head) {
     const baseRef = await ensureRefAvailable(base);
     const headRef = await ensureRefAvailable(head);
@@ -268,6 +240,7 @@ async function getChanges(base, head) {
     }
     return parseGitDiffOutput(output);
 }
+exports.getChanges = getChanges;
 async function getChangesOnHead() {
     // Get current changes - both staged and unstaged
     core.startGroup(`Change detection on HEAD`);
@@ -281,6 +254,7 @@ async function getChangesOnHead() {
     }
     return parseGitDiffOutput(output);
 }
+exports.getChangesOnHead = getChangesOnHead;
 async function getChangesSinceMergeBase(base, head, initialFetchDepth) {
     let baseRef;
     let headRef;
@@ -354,6 +328,7 @@ async function getChangesSinceMergeBase(base, head, initialFetchDepth) {
     }
     return parseGitDiffOutput(output);
 }
+exports.getChangesSinceMergeBase = getChangesSinceMergeBase;
 function parseGitDiffOutput(output) {
     const tokens = output.split('\u0000').filter(s => s.length > 0);
     const files = [];
@@ -365,6 +340,7 @@ function parseGitDiffOutput(output) {
     }
     return files;
 }
+exports.parseGitDiffOutput = parseGitDiffOutput;
 async function listAllFilesAsAdded() {
     core.startGroup('Listing all files tracked by git');
     let output = '';
@@ -383,11 +359,12 @@ async function listAllFilesAsAdded() {
         filename: path
     }));
 }
+exports.listAllFilesAsAdded = listAllFilesAsAdded;
 async function getCurrentRef() {
     core.startGroup(`Get current git ref`);
     try {
-        const branch = (await (0, exec_1.getExecOutput)('git', ['branch', '--show-current'])).stdout.trim();
-        if (branch) {
+        const branch = (await (0, exec_1.getExecOutput)('git', ['rev-parse', '--abbrev-ref', 'HEAD'])).stdout.trim();
+        if (branch && branch !== 'HEAD') {
             return branch;
         }
         const describe = await (0, exec_1.getExecOutput)('git', ['describe', '--tags', '--exact-match'], { ignoreReturnCode: true });
@@ -400,6 +377,7 @@ async function getCurrentRef() {
         core.endGroup();
     }
 }
+exports.getCurrentRef = getCurrentRef;
 function getShortName(ref) {
     if (!ref)
         return '';
@@ -411,9 +389,11 @@ function getShortName(ref) {
         return ref.slice(tags.length);
     return ref;
 }
+exports.getShortName = getShortName;
 function isGitSha(ref) {
     return /^[a-z0-9]{40}$/.test(ref);
 }
+exports.isGitSha = isGitSha;
 async function hasCommit(ref) {
     return (await (0, exec_1.getExecOutput)('git', ['cat-file', '-e', `${ref}^{commit}`], { ignoreReturnCode: true })).exitCode === 0;
 }
@@ -486,7 +466,7 @@ const statusMap = {
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.csvEscape = csvEscape;
+exports.csvEscape = void 0;
 // Returns filename escaped for CSV
 // Wraps file name into "..." only when it contains some potentially unsafe character
 function csvEscape(value) {
@@ -502,6 +482,7 @@ function csvEscape(value) {
     // another double quote
     return `"${value.replace(/"/g, '""')}"`;
 }
+exports.csvEscape = csvEscape;
 
 
 /***/ }),
@@ -512,12 +493,12 @@ function csvEscape(value) {
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.backslashEscape = backslashEscape;
-exports.shellEscape = shellEscape;
+exports.shellEscape = exports.backslashEscape = void 0;
 // Backslash escape every character except small subset of definitely safe characters
 function backslashEscape(value) {
     return value.replace(/([^a-zA-Z0-9,._+:@%/-])/gm, '\\$1');
 }
+exports.backslashEscape = backslashEscape;
 // Returns filename escaped for usage as shell argument.
 // Applies "human readable" approach with as few escaping applied as possible
 function shellEscape(value) {
@@ -538,6 +519,7 @@ function shellEscape(value) {
     // Contains some unsafe characters but no single quote
     return `'${value}'`;
 }
+exports.shellEscape = shellEscape;
 
 
 /***/ }),
@@ -563,23 +545,13 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 const fs = __importStar(__nccwpck_require__(7147));
 const core = __importStar(__nccwpck_require__(2186));
@@ -603,6 +575,7 @@ async function run() {
         const listFiles = core.getInput('list-files', { required: false }).toLowerCase() || 'none';
         const initialFetchDepth = parseInt(core.getInput('initial-fetch-depth', { required: false })) || 10;
         const predicateQuantifier = core.getInput('predicate-quantifier', { required: false }) || filter_1.PredicateQuantifier.SOME;
+        const allowOverrideOnPr = core.getBooleanInput('allow-override-on-pr', { required: false });
         if (!isExportFormat(listFiles)) {
             core.setFailed(`Input parameter 'list-files' is set to invalid value '${listFiles}'`);
             return;
@@ -614,7 +587,7 @@ async function run() {
         }
         const filterConfig = { predicateQuantifier };
         const filter = new filter_1.Filter(filtersYaml, filterConfig);
-        const files = await getChangedFiles(token, base, ref, initialFetchDepth);
+        const files = await getChangedFiles(token, base, ref, initialFetchDepth, allowOverrideOnPr);
         core.info(`Detected ${files.length} changed files`);
         const results = filter.match(files);
         exportResults(results, listFiles);
@@ -635,7 +608,7 @@ function getConfigFileContent(configPath) {
     }
     return fs.readFileSync(configPath, { encoding: 'utf8' });
 }
-async function getChangedFiles(token, base, ref, initialFetchDepth) {
+async function getChangedFiles(token, base, ref, initialFetchDepth, allowOverrideOnPr) {
     var _a, _b;
     // if base is 'HEAD' only local uncommitted changes will be detected
     // This is the simplest case as we don't need to fetch more commits or evaluate current/before refs
@@ -652,8 +625,12 @@ async function getChangedFiles(token, base, ref, initialFetchDepth) {
         case 'pull_request_review':
         case 'pull_request_review_comment':
         case 'pull_request_target': {
+            if (allowOverrideOnPr && (base || ref)) {
+                core.info(`'allow-override-on-pr' is enabled and base/ref were provided — skipping PR API and using git diff`);
+                return getChangedFilesFromGit(base, ref, initialFetchDepth);
+            }
             if (ref) {
-                core.warning(`'ref' input parameter is ignored when 'base' is set to HEAD`);
+                core.warning(`'ref' input parameter is ignored when action is triggered by pull request event`);
             }
             if (base) {
                 core.warning(`'base' input parameter is ignored when action is triggered by pull request event`);
@@ -668,7 +645,7 @@ async function getChangedFiles(token, base, ref, initialFetchDepth) {
                 // At the same time we don't want to fetch any code from forked repository
                 throw new Error(`'token' input parameter is required if action is triggered by 'pull_request_target' event`);
             }
-            core.info('Github token is not available - changes will be detected using git diff');
+            core.info('GitHub token is not available - changes will be detected using git diff');
             const baseSha = (_a = github.context.payload.pull_request) === null || _a === void 0 ? void 0 : _a.base.sha;
             const defaultBranch = (_b = github.context.payload.repository) === null || _b === void 0 ? void 0 : _b.default_branch;
             const currentRef = await git.getCurrentRef();
@@ -738,7 +715,7 @@ async function getChangedFilesFromGit(base, head, initialFetchDepth) {
 }
 // Uses github REST api to get list of files changed in PR
 async function getChangedFilesFromApi(token, pullRequest) {
-    core.startGroup(`Fetching list of changed files for PR#${pullRequest.number} from Github API`);
+    core.startGroup(`Fetching list of changed files for PR#${pullRequest.number} from GitHub API`);
     try {
         const client = github.getOctokit(token);
         const per_page = 100;

src/git.ts

@@ -166,8 +166,8 @@ export async function listAllFilesAsAdded(): Promise<File[]> {
 export async function getCurrentRef(): Promise<string> {
   core.startGroup(`Get current git ref`)
   try {
-    const branch = (await getExecOutput('git', ['branch', '--show-current'])).stdout.trim()
-    if (branch) {
+    const branch = (await getExecOutput('git', ['rev-parse', '--abbrev-ref', 'HEAD'])).stdout.trim()
+    if (branch && branch !== 'HEAD') {
       return branch
     }
 

src/main.ts

@@ -34,6 +34,7 @@ async function run(): Promise<void> {
     const listFiles = core.getInput('list-files', {required: false}).toLowerCase() || 'none'
     const initialFetchDepth = parseInt(core.getInput('initial-fetch-depth', {required: false})) || 10
     const predicateQuantifier = core.getInput('predicate-quantifier', {required: false}) || PredicateQuantifier.SOME
+    const allowOverrideOnPr = core.getBooleanInput('allow-override-on-pr', {required: false})
 
     if (!isExportFormat(listFiles)) {
       core.setFailed(`Input parameter 'list-files' is set to invalid value '${listFiles}'`)
@@ -49,7 +50,7 @@ async function run(): Promise<void> {
     const filterConfig: FilterConfig = {predicateQuantifier}
 
     const filter = new Filter(filtersYaml, filterConfig)
-    const files = await getChangedFiles(token, base, ref, initialFetchDepth)
+    const files = await getChangedFiles(token, base, ref, initialFetchDepth, allowOverrideOnPr)
     core.info(`Detected ${files.length} changed files`)
     const results = filter.match(files)
     exportResults(results, listFiles)
@@ -74,7 +75,13 @@ function getConfigFileContent(configPath: string): string {
   return fs.readFileSync(configPath, {encoding: 'utf8'})
 }
 
-async function getChangedFiles(token: string, base: string, ref: string, initialFetchDepth: number): Promise<File[]> {
+async function getChangedFiles(
+  token: string,
+  base: string,
+  ref: string,
+  initialFetchDepth: number,
+  allowOverrideOnPr: boolean
+): Promise<File[]> {
   // if base is 'HEAD' only local uncommitted changes will be detected
   // This is the simplest case as we don't need to fetch more commits or evaluate current/before refs
   if (base === git.HEAD) {
@@ -91,8 +98,12 @@ async function getChangedFiles(token: string, base: string, ref: string, initial
     case 'pull_request_review':
     case 'pull_request_review_comment':
     case 'pull_request_target': {
+      if (allowOverrideOnPr && (base || ref)) {
+        core.info(`'allow-override-on-pr' is enabled and base/ref were provided — skipping PR API and using git diff`)
+        return getChangedFilesFromGit(base, ref, initialFetchDepth)
+      }
       if (ref) {
-        core.warning(`'ref' input parameter is ignored when 'base' is set to HEAD`)
+        core.warning(`'ref' input parameter is ignored when action is triggered by pull request event`)
       }
       if (base) {
         core.warning(`'base' input parameter is ignored when action is triggered by pull request event`)
@@ -107,7 +118,7 @@ async function getChangedFiles(token: string, base: string, ref: string, initial
         // At the same time we don't want to fetch any code from forked repository
         throw new Error(`'token' input parameter is required if action is triggered by 'pull_request_target' event`)
       }
-      core.info('Github token is not available - changes will be detected using git diff')
+      core.info('GitHub token is not available - changes will be detected using git diff')
       const baseSha = github.context.payload.pull_request?.base.sha
       const defaultBranch = github.context.payload.repository?.default_branch
       const currentRef = await git.getCurrentRef()
@@ -194,7 +205,7 @@ async function getChangedFilesFromGit(base: string, head: string, initialFetchDe
 
 // Uses github REST api to get list of files changed in PR
 async function getChangedFilesFromApi(token: string, pullRequest: PullRequest): Promise<File[]> {
-  core.startGroup(`Fetching list of changed files for PR#${pullRequest.number} from Github API`)
+  core.startGroup(`Fetching list of changed files for PR#${pullRequest.number} from GitHub API`)
   try {
     const client = github.getOctokit(token)
     const per_page = 100