allow overriding ci comment

opticdev · Jan 7, 2025 · 4fa7e1d · 4fa7e1d
1 parent e4231b1
commit 4fa7e1d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/projects/optic/src/commands/ci/comment/comment.ts b/projects/optic/src/commands/ci/comment/comment.ts
@@ -51,6 +51,7 @@ export const registerCiComment = (cli: Command, config: OpticCliConfig) => {
       '--enterprise-base-url <enterprise-base-url>',
       '(only for enterprise versions of github or gitlab) - the base url to your enterprise github / gitlab instance'
     )
+    .option('--comment-url <comment-url>', 'override the url of the comment')
     .option('--verbose', 'show all operations changed in each API', false)
     .description('comment on a pull request / merge request')
     .action(
@@ -60,6 +61,7 @@ export const registerCiComment = (cli: Command, config: OpticCliConfig) => {
 
 type CommonOptions = {
   verbose: boolean;
+  commentUrl: string;
 };
 
 type UnvalidatedOptions = CommonOptions & {
@@ -153,6 +155,7 @@ const getCiCommentAction =
       await commenter.getComment(COMPARE_SUMMARY_IDENTIFIER);
     const body = generateCompareSummaryMarkdown({ sha: options.sha }, data, {
       verbose: options.verbose,
+      overrideUrl: options.commentUrl,
     });
 
     if (maybeComment) {

diff --git a/projects/optic/src/commands/ci/comment/common.ts b/projects/optic/src/commands/ci/comment/common.ts
@@ -82,7 +82,7 @@ const getCaptureIssuesLabel = ({
 export const generateCompareSummaryMarkdown = (
   commit: { sha: string },
   results: CiRunDetails,
-  options: { verbose: boolean }
+  options: { verbose: boolean; overrideUrl?: string }
 ) => {
   const anyCompletedHasWarning = results.completed.some(
     (s) => s.warnings.length > 0
@@ -122,7 +122,7 @@ ${s.apiName}
 <td>
 
 ${getOperationsText(s.comparison.groupedDiffs, {
-  webUrl: s.opticWebUrl,
+  webUrl: options.overrideUrl || s.opticWebUrl,
   verbose: options.verbose,
   labelJoiner: ',\n',
 })}
@@ -163,7 +163,7 @@ ${
 
 <td>
 
-${s.opticWebUrl ? `[View report](${s.opticWebUrl})` : ''}
+${options.overrideUrl || s.opticWebUrl ? `[View report](${options.overrideUrl || s.opticWebUrl})` : ''}
 
 </td>
 </tr>`