feat: Add variable to expand comment details automatically (#62)

Co-authored-by: Magnus Hård af Segerstad <magnus.hard-afsegerstad@regionstockholm>
Co-authored-by: Oliver Borchert <[email protected]>

Author: 3 people

README.md

@@ -71,6 +71,9 @@ GitHub Action to post the output of `terraform plan` to a pull request comment.
     # Pull request number to post the comment to (Optional)
     # Useful for workflow_dispatch triggers where PR context is not automatically available
     pr-number: ""
+
+    # Expand the PR comment details
+    expand-comment: false
 ```
 
 ### `token` (required)
@@ -108,7 +111,8 @@ multiple Terraform runs: each sticky pull request comment is identified by its h
 
 Whether to skip posting a pull request comment when no changes need to be performed. Defaults to `false`.
 
-When enabled and the plan is empty, any existing comment from a previous commit will be automatically deleted to avoid showing outdated information.
+When enabled and the plan is empty, any existing comment from a previous commit will be automatically deleted to avoid
+showing outdated information.
 
 ### `skip-comment`
 
@@ -123,6 +127,11 @@ the PR number from the event context (available for `pull_request` and `pull_req
 This parameter is particularly useful for `workflow_dispatch` triggers or other non-PR events where you want to post a
 comment to a specific pull request. You can use a previous step to find the PR number associated with your branch.
 
+### `expand-comment`
+
+Whether to expand the comment details. When enabled, the detail points in the pull request comment are expanded by
+default.
+
 ## Outputs
 
 This action provides the following output:

action.yml

@@ -32,9 +32,15 @@ inputs:
     required: true
     default: "false"
   pr-number:
-    description: The pull request number to post the comment to. When not provided, the action will attempt to automatically determine the PR number from the event context. This is useful for workflow_dispatch triggers.
+    description:
+      The pull request number to post the comment to. When not provided, the action will attempt to automatically
+      determine the PR number from the event context. This is useful for workflow_dispatch triggers.
     required: false
     default: ""
+  expand-comment:
+    description: Whether to expand the comment details by default.
+    required: true
+    default: "false"
 outputs:
   markdown:
     description: The raw markdown output of the terraform plan

dist/index.js

@@ -3,16 +3,20 @@ import * as github from '@actions/github'
 import type { PullRequestEvent } from '@octokit/webhooks-types'
 import { planIsEmpty, type RenderedPlan } from './render'
 
-function renderResources(resources: Record<string, string>): string {
+function renderResources(
+  resources: Record<string, string>,
+  options: { expandDetails: boolean }
+): string {
   let result = ''
   for (const key of Object.keys(resources).sort()) {
     const content = resources[key]
-    result += `\n\n<details><summary><code>${key}</code></summary>\n\n${content}\n\n</details>`
+    const openAttr = options.expandDetails ? ' open' : ''
+    result += `\n\n<details${openAttr}><summary><code>${key}</code></summary>\n\n${content}\n\n</details>`
   }
   return result
 }
 
-function renderBody(plan: RenderedPlan): string {
+function renderBody(plan: RenderedPlan, options: { expandDetails: boolean }): string {
   if (planIsEmpty(plan)) {
     return '**→ No Resource Changes!**'
   }
@@ -27,23 +31,23 @@ function renderBody(plan: RenderedPlan): string {
 
   if (plan.createdResources) {
     body += '\n\n### ✨ Create'
-    body += renderResources(plan.createdResources)
+    body += renderResources(plan.createdResources, options)
   }
   if (plan.updatedResources) {
     body += '\n\n### ♻️ Update'
-    body += renderResources(plan.updatedResources)
+    body += renderResources(plan.updatedResources, options)
   }
   if (plan.recreatedResources) {
     body += '\n\n### ⚙️ Re-Create'
-    body += renderResources(plan.recreatedResources)
+    body += renderResources(plan.recreatedResources, options)
   }
   if (plan.deletedResources) {
     body += '\n\n### 🗑️ Delete'
-    body += renderResources(plan.deletedResources)
+    body += renderResources(plan.deletedResources, options)
   }
   if (plan.ephemeralResources) {
     body += '\n\n### 👻 Ephemeral'
-    body += renderResources(plan.ephemeralResources)
+    body += renderResources(plan.ephemeralResources, options)
   }
 
   return body
@@ -52,14 +56,16 @@ function renderBody(plan: RenderedPlan): string {
 export function renderMarkdown({
   plan,
   header,
-  includeFooter
+  includeFooter,
+  expandDetails
 }: {
   plan: RenderedPlan
   header: string
   includeFooter?: boolean
+  expandDetails: boolean
 }): string {
   // Build body
-  const body = renderBody(plan)
+  const body = renderBody(plan, { expandDetails })
 
   // Build footer
   let footer = ''

src/comment.ts

@@ -14,7 +14,8 @@ async function run() {
     header: core.getInput('header', { required: true }),
     skipEmpty: core.getBooleanInput('skip-empty', { required: true }),
     skipComment: core.getBooleanInput('skip-comment', { required: true }),
-    prNumber: prNumberInput && prNumberInput !== '' ? parseInt(prNumberInput, 10) : undefined
+    prNumber: prNumberInput && prNumberInput !== '' ? parseInt(prNumberInput, 10) : undefined,
+    expandComment: core.getBooleanInput('expand-comment', { required: true })
   }
   const octokit = github.getOctokit(inputs.token)
 
@@ -29,7 +30,11 @@ async function run() {
 
   // 3) Render the plan diff markdown and set it as output
   const planMarkdown = await core.group('Render plan diff markdown', async () => {
-    const markdown = renderMarkdown({ plan, header: inputs.header })
+    const markdown = renderMarkdown({
+      plan,
+      header: inputs.header,
+      expandDetails: inputs.expandComment
+    })
     core.setOutput('markdown', markdown)
     core.setOutput('empty', planIsEmpty(plan))
     return markdown

src/index.ts

@@ -18,7 +18,8 @@ test.each([
   const renderedMarkdown = renderMarkdown({
     plan: renderedPlan,
     header: '📝 Terraform Plan',
-    includeFooter: false
+    includeFooter: false,
+    expandDetails: false
   })
 
   if (process.env.GENERATE_FIXTURE === '1') {