feat(repo): add PR number input to filter-paths helper

dist/helpers/filter-paths.js

@@ -27,36 +27,39 @@ import {
 var import_micromatch = __toESM(require_micromatch(), 1);
 class FilterPaths extends HelperInputs {
 }
-var filterPaths = async ({ paths, globs, sha, packages, merge_queue_enabled }) => {
+var filterPaths = async ({ paths, globs, sha, packages, merge_queue_enabled, pull_number }) => {
   if (!paths && !globs && !packages) {
     error("Must pass `globs` or `paths` or `packages` for filtering");
     return false;
   }
-  let pull_number;
-  if (context.eventName === "merge_group") {
-    pull_number = getPrNumberFromMergeQueueRef();
+  let pullNumber;
+  if (pull_number) {
+    pullNumber = Number(pull_number);
+  } else if (context.eventName === "merge_group") {
+    pullNumber = getPrNumberFromMergeQueueRef();
   } else if (sha && merge_queue_enabled === "true") {
     const branchesResult = sha ? await octokit.repos.listBranchesForHeadCommit({
       commit_sha: sha,
       ...context.repo
     }) : undefined;
     const branchName = branchesResult?.data[0]?.name;
-    pull_number = getPrNumberFromMergeQueueRef(branchName);
+    pullNumber = getPrNumberFromMergeQueueRef(branchName);
   } else if (sha) {
     const listPrsResult = await octokit.repos.listPullRequestsAssociatedWithCommit({
       commit_sha: sha,
       ...context.repo
     });
     const prFromSha = listPrsResult?.data.find(Boolean);
-    if (!prFromSha)
+    if (!prFromSha) {
       throw new Error(`No PR found for commit ${sha}`);
-    pull_number = prFromSha.number;
+    }
+    pullNumber = prFromSha.number;
   } else {
-    pull_number = context.issue.number;
+    pullNumber = context.issue.number;
   }
   const { data } = await octokit.pulls.listFiles({
     per_page: 100,
-    pull_number,
+    pull_number: pullNumber,
     ...context.repo
   });
   if (packages && hasRelevantPackageChanged(data, packages)) {
@@ -87,4 +90,4 @@ export {
   FilterPaths
 };
 
-//# debugId=F57369BFE892E36464756E2164756E21
+//# debugId=974DDF1916D9FA6564756E2164756E21

src/helpers/filter-paths.ts

@@ -25,17 +25,21 @@ export class FilterPaths extends HelperInputs {
   declare sha?: string;
   declare packages?: string;
   declare merge_queue_enabled?: string;
+  declare pull_number?: string;
 }
 
-export const filterPaths = async ({ paths, globs, sha, packages, merge_queue_enabled }: FilterPaths) => {
+export const filterPaths = async ({ paths, globs, sha, packages, merge_queue_enabled, pull_number }: FilterPaths) => {
   if (!paths && !globs && !packages) {
     core.error('Must pass `globs` or `paths` or `packages` for filtering');
     return false;
   }
 
-  let pull_number: number;
-  if (context.eventName === 'merge_group') {
-    pull_number = getPrNumberFromMergeQueueRef();
+  let pullNumber: number;
+
+  if (pull_number) {
+    pullNumber = Number(pull_number);
+  } else if (context.eventName === 'merge_group') {
+    pullNumber = getPrNumberFromMergeQueueRef();
   } else if (sha && merge_queue_enabled === 'true') {
     const branchesResult = sha
       ? await octokit.repos.listBranchesForHeadCommit({
@@ -44,22 +48,27 @@ export const filterPaths = async ({ paths, globs, sha, packages, merge_queue_ena
         })
       : undefined;
     const branchName = branchesResult?.data[0]?.name;
-    pull_number = getPrNumberFromMergeQueueRef(branchName);
+
+    pullNumber = getPrNumberFromMergeQueueRef(branchName);
   } else if (sha) {
     const listPrsResult = await octokit.repos.listPullRequestsAssociatedWithCommit({
       commit_sha: sha,
       ...context.repo
     });
+
     const prFromSha = listPrsResult?.data.find(Boolean);
-    if (!prFromSha) throw new Error(`No PR found for commit ${sha}`);
-    pull_number = prFromSha.number;
+    if (!prFromSha) {
+      throw new Error(`No PR found for commit ${sha}`);
+    }
+
+    pullNumber = prFromSha.number;
   } else {
-    pull_number = context.issue.number;
+    pullNumber = context.issue.number;
   }
 
   const { data } = await octokit.pulls.listFiles({
     per_page: 100,
-    pull_number,
+    pull_number: pullNumber,
     ...context.repo
   });
 

test/helpers/filter-paths.test.ts

@@ -242,6 +242,51 @@ describe('filterPaths', () => {
     expect(octokit.repos.listPullRequestsAssociatedWithCommit).not.toHaveBeenCalled();
   });
 
+  it('should use pull_number input over merge queue pull number', async () => {
+    context.eventName = 'merge_group';
+    context.ref = 'refs/heads/gh-readonly-queue/default-branch/pr-12345-f0d9a4cb862b13cdaab6522f72d6dc17e4336b7f';
+
+    await filterPaths({
+      paths,
+      pull_number: '456'
+    });
+
+    expect(octokit.pulls.listFiles).toHaveBeenCalledWith({
+      per_page: 100,
+      pull_number: 456,
+      ...context.repo
+    });
+  });
+
+  it('should use pull_number input over sha-derived pull number', async () => {
+    await filterPaths({
+      paths,
+      sha: 'sha',
+      pull_number: '456'
+    });
+
+    expect(octokit.pulls.listFiles).toHaveBeenCalledWith({
+      per_page: 100,
+      pull_number: 456,
+      ...context.repo
+    });
+    expect(octokit.repos.listPullRequestsAssociatedWithCommit).not.toHaveBeenCalled();
+  });
+
+  it('should pass NaN pull number when pull_number input is non-numeric', async () => {
+    await filterPaths({
+      paths,
+      pull_number: 'not-a-number'
+    });
+
+    expect(octokit.pulls.listFiles).toHaveBeenCalledWith({
+      per_page: 100,
+      pull_number: Number.NaN,
+      ...context.repo
+    });
+    expect(octokit.repos.listPullRequestsAssociatedWithCommit).not.toHaveBeenCalled();
+  });
+
   it('should return false when no filtering params are passed', async () => {
     const result = await filterPaths({});