Merge pull request #52 from getappmap/feat/add-issue-parameter

If we pass an issue number to the action use it in the analysis

README.md

@@ -107,6 +107,11 @@ Add a step like this to your workflow:
     # comment be submitted on any workflow run.
     project-summary: true
 
+    # Explicitly pass the issue number to the analyze function.  This is useful in cases where
+    # you are triggering this action via a webhook from another service and the action is not aware
+    # of which Pull Request to comment an analysis report on.
+    issue-number: 14
+
     # Enable verbose logging of CLI subcommands. You can use the standard GitHub
     # Action log level option to control verbosity of this Action itself.
     # Default: false

action.yml

@@ -60,6 +60,11 @@ inputs:
       Enable the project summary report. This feature is also enabled automatically when a pull
       request contains the archive-action configuration report.
     default: 'false'
+  issue-number:
+    description:
+      Explicitly pass the issue number to the analyze function.  This is useful in cases where
+      you are triggering this action via a webhook from another service and the action is not aware
+      of which Pull Request to comment an analysis report on.
   verbose:
     description: Enable verbose logging.
 outputs:

dist/analyze/index.js

@@ -28968,6 +28968,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.parseIssueNumber = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const argparse_1 = __nccwpck_require__(1515);
 const action_utils_1 = __nccwpck_require__(1259);
@@ -28996,6 +28997,7 @@ function runInGitHub() {
         const retentionDays = parseInt(core.getInput('retention-days') || '7', 10);
         const threadCount = threadCountStr ? parseInt(threadCountStr, 10) : undefined;
         const projectSummary = core.getBooleanInput('project-summary');
+        const issueNumber = parseIssueNumber(core.getInput('issue-number'));
         const baseRevision = baseRevisionArg || process.env.GITHUB_BASE_REF;
         if (!baseRevision)
             throw new Error('base-revision argument must be provided, or GITHUB_BASE_REF must be available from GitHub (https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables).');
@@ -29057,7 +29059,7 @@ function runInGitHub() {
             yield projectSummaryReport.comment(octokit, projectSummaryReportResult.reportFile);
         }
         {
-            const commenter = new action_utils_1.Commenter(octokit, 'appmap');
+            const commenter = new action_utils_1.Commenter(octokit, 'appmap', issueNumber);
             yield commenter.comment(compareReportResult.reportFile);
         }
         {
@@ -29147,6 +29149,18 @@ if (require.main === require.cache[eval('__filename')]) {
     else
         runLocally();
 }
+function parseIssueNumber(input) {
+    // If the input is a number and it's an integer, return it directly
+    if (typeof input === 'number' && Number.isInteger(input)) {
+        return input;
+    }
+    if (typeof input !== 'string') {
+        return undefined;
+    }
+    const parsed = parseInt(input);
+    return isNaN(parsed) ? undefined : parsed;
+}
+exports.parseIssueNumber = parseIssueNumber;
 
 
 /***/ }),

src/analyze.ts

@@ -39,6 +39,7 @@ async function runInGitHub(): Promise<void> {
   const retentionDays = parseInt(core.getInput('retention-days') || '7', 10);
   const threadCount = threadCountStr ? parseInt(threadCountStr, 10) : undefined;
   const projectSummary = core.getBooleanInput('project-summary');
+  const issueNumber = parseIssueNumber(core.getInput('issue-number'));
 
   const baseRevision = baseRevisionArg || process.env.GITHUB_BASE_REF;
   if (!baseRevision)
@@ -116,7 +117,7 @@ async function runInGitHub(): Promise<void> {
   }
 
   {
-    const commenter = new Commenter(octokit, 'appmap');
+    const commenter = new Commenter(octokit, 'appmap', issueNumber);
     await commenter.comment(compareReportResult.reportFile);
   }
   {
@@ -206,3 +207,17 @@ if (require.main === module) {
   if (process.env.CI) runInGitHub();
   else runLocally();
 }
+
+export function parseIssueNumber(input: unknown): number | undefined {
+  // If the input is a number and it's an integer, return it directly
+  if (typeof input === 'number' && Number.isInteger(input)) {
+    return input;
+  }
+
+  if (typeof input !== 'string') {
+    return undefined;
+  }
+
+  const parsed = parseInt(input);
+  return isNaN(parsed) ? undefined : parsed;
+}

test/analyze.spec.ts

@@ -0,0 +1,40 @@
+import { parseIssueNumber } from '../src/analyze';
+
+describe('parseIssueNumber', () => {
+  it('should return an integer when an integer is provided', () => {
+    expect(parseIssueNumber(123)).toEqual(123);
+  });
+
+  it('should return an integer when a numeric string is provided', () => {
+    expect(parseIssueNumber('123')).toEqual(123);
+  });
+
+  it('should return undefined when a non-numeric string is provided', () => {
+    expect(parseIssueNumber('abc')).toBeUndefined();
+  });
+
+  it('should return undefined when an empty string is provided', () => {
+    expect(parseIssueNumber('')).toBeUndefined();
+  });
+
+  it('should return undefined when a string with spaces is provided', () => {
+    expect(parseIssueNumber('  ')).toBeUndefined();
+  });
+
+  it('should return undefined when a null value is provided', () => {
+    expect(parseIssueNumber(null)).toBeUndefined();
+  });
+
+  it('should return undefined when an undefined value is provided', () => {
+    expect(parseIssueNumber(undefined)).toBeUndefined();
+  });
+
+  it('should return undefined when a boolean value is provided', () => {
+    expect(parseIssueNumber(true)).toBeUndefined();
+    expect(parseIssueNumber(false)).toBeUndefined();
+  });
+
+  it('should return the integer part when a string with a number and letters is provided', () => {
+    expect(parseIssueNumber('123abc')).toEqual(123);
+  });
+});