refactor: hide no-changes comment instead of skipping; rename input

leetrout · claude · leetrout · commit 2d28d720bf54 · 2026-05-20T20:34:07.000-04:00
Per reviewer feedback on PR #414: - Post the comment but minimize it via GitHub GraphQL when there are no changes, preserving the PR_RELEASE_MARKER for idempotency checks - Rename input from disable-no-changes-comment to hide-no-changes-pr-comment and camelCase field from disableNoChangesComment to hideNoChangesPrComment Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
diff --git a/__tests__/config.test.ts b/__tests__/config.test.ts
@@ -338,7 +338,7 @@ describe('config', () => {
       expect(config.disableWiki).toBe(false);
       expect(config.wikiSidebarChangelogMax).toBe(5);
       expect(config.disableBranding).toBe(false);
-      expect(config.disableNoChangesComment).toBe(false);
+      expect(config.hideNoChangesPrComment).toBe(false);
       expect(config.githubToken).toBe('ghp_test_token_2c6912E7710c838347Ae178B4');
       expect(config.modulePathIgnore).toEqual([]);
       expect(config.moduleChangeExcludePatterns).toEqual(['.gitignore', '*.md', '*.tftest.hcl', 'tests/**']);
@@ -368,7 +368,7 @@ describe('config', () => {
         ['Use Version Prefix: true'],
         ['Module Ref Mode: tag'],
         ['Pre-release: false'],
-        ['Disable No-Changes Comment: false'],
+        ['Hide No-Changes PR Comment: false'],
       ]);
     });
   });
diff --git a/__tests__/helpers/octokit.ts b/__tests__/helpers/octokit.ts
@@ -342,6 +342,7 @@ export function createDefaultOctokitMock(): OctokitRestApi {
         })();
       },
     },
+    graphql: vi.fn().mockResolvedValue({ minimizeComment: { minimizedComment: { isMinimized: true } } }),
   };
 
   // For now, we just emulate and return a Partial OctokitRestApi since this is a mocked version
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -63,7 +63,7 @@ describe('main', () => {
     context.isPrMergeEvent = false;
     config.disableWiki = false;
     config.deleteLegacyTags = true;
-    config.disableNoChangesComment = false;
+    config.hideNoChangesPrComment = false;
 
     // Reset mocks with default values
     vi.mocked(hasReleaseComment).mockResolvedValue(false);
@@ -229,14 +229,15 @@ describe('main', () => {
       vi.mocked(TerraformModule.getTagsToDelete).mockReturnValue([]);
     });
 
-    it('should skip PR comment when no version changes and disable-no-changes-comment is true', async () => {
-      config.disableNoChangesComment = true;
+    it('should call addReleasePlanComment (for hiding) when no version changes and hide-no-changes-pr-comment is true', async () => {
+      config.hideNoChangesPrComment = true;
       vi.mocked(TerraformModule.getModulesNeedingRelease).mockReturnValue([]);
+      vi.mocked(getWikiStatus).mockReturnValue({ status: WIKI_STATUS.SUCCESS });
 
       await run();
 
-      expect(addReleasePlanComment).not.toHaveBeenCalled();
-      expect(info).toHaveBeenCalledWith('No version changes detected. Skipping PR comment.');
+      // addReleasePlanComment is always called; minimization happens inside it
+      expect(addReleasePlanComment).toHaveBeenCalled();
 
       // Should NOT call merge-specific functions
       expect(createTaggedReleases).not.toHaveBeenCalled();
@@ -246,17 +247,17 @@ describe('main', () => {
       expect(setOutput).toHaveBeenCalled();
     });
 
-    it('should skip PR comment when no module changes and delete-legacy-tags is disabled even with items to delete', async () => {
-      config.disableNoChangesComment = true;
+    it('should call addReleasePlanComment when no module changes and delete-legacy-tags is disabled even with items to delete', async () => {
+      config.hideNoChangesPrComment = true;
       config.deleteLegacyTags = false;
       vi.mocked(TerraformModule.getModulesNeedingRelease).mockReturnValue([]);
       vi.spyOn(TerraformModule, 'getReleasesToDelete').mockReturnValue([{ id: 1, title: 'old', body: '', tagName: 'modules/old/v0' }]);
       vi.spyOn(TerraformModule, 'getTagsToDelete').mockReturnValue(['modules/old/v0']);
+      vi.mocked(getWikiStatus).mockReturnValue({ status: WIKI_STATUS.SUCCESS });
 
       await run();
 
-      expect(addReleasePlanComment).not.toHaveBeenCalled();
-      expect(info).toHaveBeenCalledWith('No version changes detected. Skipping PR comment.');
+      expect(addReleasePlanComment).toHaveBeenCalled();
     });
 
     it('should handle non-merge event (pull request event) when modules need release', async () => {
@@ -307,18 +308,18 @@ describe('main', () => {
       });
     });
 
-    it('should skip PR comment when disable-no-changes-comment is true and no changes', async () => {
-      config.disableNoChangesComment = true;
+    it('should call addReleasePlanComment when hide-no-changes-pr-comment is true and no changes', async () => {
+      config.hideNoChangesPrComment = true;
       vi.mocked(TerraformModule.getModulesNeedingRelease).mockReturnValue([]);
+      vi.mocked(getWikiStatus).mockReturnValue({ status: WIKI_STATUS.SUCCESS });
 
       await run();
 
-      expect(addReleasePlanComment).not.toHaveBeenCalled();
-      expect(info).toHaveBeenCalledWith('No version changes detected. Skipping PR comment.');
+      expect(addReleasePlanComment).toHaveBeenCalled();
     });
 
-    it('should still post PR comment when disable-no-changes-comment is true but modules need release', async () => {
-      config.disableNoChangesComment = true;
+    it('should post PR comment visibly when hide-no-changes-pr-comment is true but modules need release', async () => {
+      config.hideNoChangesPrComment = true;
       vi.mocked(TerraformModule.getModulesNeedingRelease).mockReturnValue([mockTerraformModuleNeedingRelease]);
       vi.mocked(getWikiStatus).mockReturnValue({ status: WIKI_STATUS.SUCCESS });
 
@@ -327,8 +328,8 @@ describe('main', () => {
       expect(addReleasePlanComment).toHaveBeenCalled();
     });
 
-    it('should still post PR comment when disable-no-changes-comment is true but there are legacy items to delete', async () => {
-      config.disableNoChangesComment = true;
+    it('should post PR comment visibly when hide-no-changes-pr-comment is true but there are legacy items to delete', async () => {
+      config.hideNoChangesPrComment = true;
       vi.mocked(TerraformModule.getModulesNeedingRelease).mockReturnValue([]);
       vi.mocked(TerraformModule.getReleasesToDelete).mockReturnValue([{ id: 99, title: 'old', body: '', tagName: 'old/v1.0.0' }]);
       vi.mocked(getWikiStatus).mockReturnValue({ status: WIKI_STATUS.SUCCESS });
diff --git a/__tests__/pull-request.test.ts b/__tests__/pull-request.test.ts
@@ -473,6 +473,61 @@ describe('pull-request', () => {
       );
     });
 
+    it('should minimize comment when hide-no-changes-pr-comment is true and no changes', async () => {
+      const nodeId = 'IC_test_node_id';
+      config.set({ hideNoChangesPrComment: true, deleteLegacyTags: true });
+      stubOctokitReturnData('issues.createComment', {
+        data: { id: 1, node_id: nodeId, html_url: 'https://github.com/org/repo/pull/1#issuecomment-1' },
+      });
+      stubOctokitReturnData('issues.listComments', { data: [] });
+
+      await addReleasePlanComment([], [], [], { status: WIKI_STATUS.SUCCESS });
+
+      expect(context.octokit.graphql).toHaveBeenCalledWith(
+        expect.stringContaining('minimizeComment'),
+        { id: nodeId },
+      );
+      expect(info).toHaveBeenCalledWith(expect.stringContaining('Minimized comment'));
+    });
+
+    it('should not minimize comment when hide-no-changes-pr-comment is true but modules need release', async () => {
+      config.set({ hideNoChangesPrComment: true });
+      stubOctokitReturnData('issues.createComment', {
+        data: { id: 1, node_id: 'IC_node', html_url: 'https://github.com/org/repo/pull/1#issuecomment-1' },
+      });
+      stubOctokitReturnData('issues.listComments', { data: [] });
+
+      await addReleasePlanComment(terraformModules, [], [], { status: WIKI_STATUS.SUCCESS });
+
+      expect(context.octokit.graphql).not.toHaveBeenCalled();
+    });
+
+    it('should not minimize comment when hide-no-changes-pr-comment is true but there are releases to delete', async () => {
+      config.set({ hideNoChangesPrComment: true, deleteLegacyTags: true });
+      stubOctokitReturnData('issues.createComment', {
+        data: { id: 1, node_id: 'IC_node', html_url: 'https://github.com/org/repo/pull/1#issuecomment-1' },
+      });
+      stubOctokitReturnData('issues.listComments', { data: [] });
+
+      await addReleasePlanComment([], [{ id: 99, title: 'old', body: '', tagName: 'old/v1.0.0' }], [], {
+        status: WIKI_STATUS.SUCCESS,
+      });
+
+      expect(context.octokit.graphql).not.toHaveBeenCalled();
+    });
+
+    it('should not minimize comment when hide-no-changes-pr-comment is false', async () => {
+      config.set({ hideNoChangesPrComment: false });
+      stubOctokitReturnData('issues.createComment', {
+        data: { id: 1, node_id: 'IC_node', html_url: 'https://github.com/org/repo/pull/1#issuecomment-1' },
+      });
+      stubOctokitReturnData('issues.listComments', { data: [] });
+
+      await addReleasePlanComment([], [], [], { status: WIKI_STATUS.SUCCESS });
+
+      expect(context.octokit.graphql).not.toHaveBeenCalled();
+    });
+
     it('should include modules to remove when flag enabled', async () => {
       const modulesToRemove = ['legacy-module1', 'legacy-module2'];
 
diff --git a/__tests__/utils/metadata.test.ts b/__tests__/utils/metadata.test.ts
@@ -19,7 +19,7 @@ describe('utils/metadata', () => {
         'wiki-sidebar-changelog-max',
         'wiki-usage-template',
         'disable-branding',
-        'disable-no-changes-comment',
+        'hide-no-changes-pr-comment',
         'module-path-ignore',
         'module-change-exclude-patterns',
         'module-asset-exclude-patterns',
@@ -61,7 +61,7 @@ describe('utils/metadata', () => {
         'delete-legacy-tags',
         'disable-wiki',
         'disable-branding',
-        'disable-no-changes-comment',
+        'hide-no-changes-pr-comment',
         'use-ssh-source-format',
         'use-version-prefix',
         'pre-release',
@@ -134,7 +134,7 @@ describe('utils/metadata', () => {
         'wiki-sidebar-changelog-max': 'wikiSidebarChangelogMax',
         'wiki-usage-template': 'wikiUsageTemplate',
         'disable-branding': 'disableBranding',
-        'disable-no-changes-comment': 'disableNoChangesComment',
+        'hide-no-changes-pr-comment': 'hideNoChangesPrComment',
         'module-path-ignore': 'modulePathIgnore',
         'module-change-exclude-patterns': 'moduleChangeExcludePatterns',
         'module-asset-exclude-patterns': 'moduleAssetExcludePatterns',
diff --git a/action.yml b/action.yml
@@ -111,11 +111,13 @@ inputs:
       or where third-party branding is undesirable.
     required: true
     default: "false"
-  disable-no-changes-comment:
+  hide-no-changes-pr-comment:
     description: >
-      When set to true, suppresses the PR comment when there are no module changes and no legacy
-      tags/releases to delete. Has no effect when there are changes to report; comments are always
-      posted in that case. By default, this is false so a comment is always posted.
+      When set to true, hides (minimizes) the PR comment when there are no module changes and no
+      legacy tags/releases to delete. The comment is still posted so the release marker remains
+      present for idempotency checks, but it will appear collapsed/hidden by default. Has no effect
+      when there are changes to report; comments are always posted visibly in that case. By default,
+      this is false so a comment is always posted visibly.
     required: true
     default: "false"
   module-path-ignore:
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/config.ts b/src/config.ts
@@ -127,7 +127,7 @@ function initializeConfig(): Config {
     info(`Use Version Prefix: ${configInstance.useVersionPrefix}`);
     info(`Module Ref Mode: ${configInstance.moduleRefMode}`);
     info(`Pre-release: ${configInstance.preRelease}`);
-    info(`Disable No-Changes Comment: ${configInstance.disableNoChangesComment}`);
+    info(`Hide No-Changes PR Comment: ${configInstance.hideNoChangesPrComment}`);
 
     return configInstance;
   } finally {
diff --git a/src/main.ts b/src/main.ts
@@ -33,19 +33,10 @@ function initialize(): { config: Config; context: Context } {
  * @returns {Promise<void>} Resolves when wiki-related operations are completed.
  */
 async function handlePullRequestEvent(
-  config: Config,
   terraformModules: TerraformModule[],
   releasesToDelete: GitHubRelease[],
   tagsToDelete: string[],
 ): Promise<void> {
-  const modulesNeedingRelease = TerraformModule.getModulesNeedingRelease(terraformModules);
-  const hasDeleteWork = config.deleteLegacyTags && (releasesToDelete.length > 0 || tagsToDelete.length > 0);
-
-  if (config.disableNoChangesComment && modulesNeedingRelease.length === 0 && !hasDeleteWork) {
-    info('No version changes detected. Skipping PR comment.');
-    return;
-  }
-
   const wikiStatusResult = getWikiStatus();
   await addReleasePlanComment(terraformModules, releasesToDelete, tagsToDelete, wikiStatusResult);
 
@@ -228,7 +219,7 @@ export async function run(): Promise<void> {
     if (context.isPrMergeEvent) {
       await handlePullRequestMergedEvent(config, terraformModules, releasesToDelete, tagsToDelete);
     } else {
-      await handlePullRequestEvent(config, terraformModules, releasesToDelete, tagsToDelete);
+      await handlePullRequestEvent(terraformModules, releasesToDelete, tagsToDelete);
     }
   } catch (error) {
     if (error instanceof Error) {
diff --git a/src/pull-request.ts b/src/pull-request.ts
@@ -347,6 +347,20 @@ export async function addReleasePlanComment(
     });
     info(`Posted comment ${newComment.id} @ ${newComment.html_url}`);
 
+    // Minimize the comment if configured and there is nothing to report
+    const hasDeleteWork = config.deleteLegacyTags && (releasesToDelete.length > 0 || tagsToDelete.length > 0);
+    if (config.hideNoChangesPrComment && terraformModulesToRelese.length === 0 && !hasDeleteWork) {
+      await octokit.graphql(
+        `mutation MinimizeComment($id: ID!) {
+          minimizeComment(input: {subjectId: $id, classifier: RESOLVED}) {
+            minimizedComment { isMinimized }
+          }
+        }`,
+        { id: newComment.node_id },
+      );
+      info(`Minimized comment ${newComment.id} (no changes to report)`);
+    }
+
     // Filter out the comments that contain the PR summary marker and are not the current comment
     const { data: allComments } = await octokit.rest.issues.listComments({ issue_number, owner, repo });
     const commentsToDelete = allComments.filter(
diff --git a/src/types/config.types.ts b/src/types/config.types.ts
@@ -183,11 +183,11 @@ export interface Config {
   useVersionPrefix: boolean;
 
   /**
-   * When true, suppresses the PR comment when there are no module changes and no legacy
+   * When true, hides (minimizes) the PR comment when there are no module changes and no legacy
    * tags/releases to delete. Has no effect when there are changes to report.
    * By default, this is false so a comment is always posted (existing behavior).
    */
-  disableNoChangesComment: boolean;
+  hideNoChangesPrComment: boolean;
 
   /**
    * Controls how Terraform module usage examples reference versions in generated documentation.
diff --git a/src/types/github.types.ts b/src/types/github.types.ts
@@ -1,3 +1,4 @@
+import type { graphql as GraphqlFn } from '@octokit/graphql';
 import type { PaginateInterface } from '@octokit/plugin-paginate-rest';
 import type { Api } from '@octokit/plugin-rest-endpoint-methods';
 
@@ -6,9 +7,9 @@ import type { Api } from '@octokit/plugin-rest-endpoint-methods';
  */
 
 /**
- * Custom type that extends Octokit with pagination support
+ * Custom type that extends Octokit with pagination and GraphQL support
  */
-export type OctokitRestApi = Api & { paginate: PaginateInterface };
+export type OctokitRestApi = Api & { paginate: PaginateInterface; graphql: typeof GraphqlFn };
 
 /**
  * GitHub tag information
diff --git a/src/utils/metadata.ts b/src/utils/metadata.ts
