Merge pull request #199 from hashicorp/ds.ntp-skipcomment

Author: dstaley

.changeset/moody-bags-design.md

@@ -0,0 +1,5 @@
+---
+'@hashicorp/platform-tools': minor
+---
+
+Add support for skipCommentIfEmpty

packages/tools/scripts/next-touched-pages/__tests__/index.test.ts

@@ -6,7 +6,7 @@ describe('next-touched-pages', () => {
 
     it('generates a comment when changedPages is empty', async () => {
       const { generateCommentMarkdown } = await import('../')
-      expect(generateCommentMarkdown([], {})).toBe(`<h2>Changed Pages</h2>
+      expect(generateCommentMarkdown([], {})).toBe(`<h2>📄 Changed Pages</h2>
 <br>
 This PR doesn't appear to affect any pages.<br>
 This comment was generated by <a href="https://github.com/hashicorp/web-platform-packages/tree/main/packages/tools/scripts/next-touched-pages"><code>next-touched-pages</code></a> and isn't guaranteed to be accurate.<br>
@@ -20,7 +20,7 @@ This comment was generated by <a href="https://github.com/hashicorp/web-platform
           baseBranch: 'main',
           branch: 'feature',
         })
-      ).toBe(`<h2>Changed Pages</h2>
+      ).toBe(`<h2>📄 Changed Pages</h2>
 <table><tr><th>Page</th><th><code>main</code></th><th><code>feature</code></th></tr><tr><td><code>/</code></td><td><li><code>/</code></li></td><td><li><code>/</code></li></td></tr></table>
 <br>
 This comment was generated by <a href="https://github.com/hashicorp/web-platform-packages/tree/main/packages/tools/scripts/next-touched-pages"><code>next-touched-pages</code></a> and isn't guaranteed to be accurate.<br>
@@ -39,7 +39,7 @@ This comment was generated by <a href="https://github.com/hashicorp/web-platform
           deployUrl: 'feature-test.example',
           baseBranchDeployUrl: 'main-test.example',
         })
-      ).toBe(`<h2>Changed Pages</h2>
+      ).toBe(`<h2>📄 Changed Pages</h2>
 <table><tr><th>Page</th><th><code>main</code></th><th><code>feature</code></th></tr><tr><td><code>/[page]</code></td><td><li><a href="https://main-test.example/one"><code>/[page]</code> #1</a></li><li><a href="https://main-test.example/two"><code>/[page]</code> #2</a></li></td><td><li><a href="https://feature-test.example/one"><code>/[page]</code> #1</a></li><li><a href="https://feature-test.example/two"><code>/[page]</code> #2</a></li></td></tr></table>
 <br>
 This comment was generated by <a href="https://github.com/hashicorp/web-platform-packages/tree/main/packages/tools/scripts/next-touched-pages"><code>next-touched-pages</code></a> and isn't guaranteed to be accurate.<br>

packages/tools/scripts/next-touched-pages/index.ts

@@ -18,6 +18,7 @@ interface BuildManifest {
 interface Configuration {
   name?: string
   paths?: Record<string, string[]>
+  skipCommentIfEmpty?: boolean
 }
 
 const css = /\/\*+[\s\S]*?sourceMappingURL\s*=([\s\S]*?)\*\//
@@ -245,17 +246,25 @@ export function generateCommentMarkdown(
     deployUrl,
     dynamicPathsConfig,
     packageName,
+    skipCommentIfEmpty,
   }: {
     baseBranch?: string
     baseBranchDeployUrl?: string
     branch?: string
     deployUrl?: string
     dynamicPathsConfig?: Record<string, string[]>
     packageName?: string
+    skipCommentIfEmpty?: boolean
   }
 ): string {
+  // If there aren't any changed pages and skipCommentIfEmpty is truthy, return
+  // an empty string.
+  if (skipCommentIfEmpty && changedPages.length === 0) {
+    return ''
+  }
+
   let comment = summary.addHeading(
-    packageName ? `Changed Pages for ${packageName}` : 'Changed Pages',
+    packageName ? `📄 Changed Pages for ${packageName}` : '📄 Changed Pages',
     2
   )
   if (changedPages.length > 0) {
@@ -400,6 +409,7 @@ export default async function main() {
           baseBranchDeployUrl: argv.baseBranchDeployUrl,
           dynamicPathsConfig: config.paths,
           packageName: config.name,
+          skipCommentIfEmpty: config.skipCommentIfEmpty,
         })
         break
     }