feat: Output markdown as Step Summary and Text, and Optionally Output PR comment (#35)

Co-authored-by: Oliver Borchert <[email protected]>

Author: Kludgy4

.github/workflows/e2e.yml

@@ -36,3 +36,4 @@ jobs:
           token: ${{ github.token }}
           planfile: .planfile
           working-directory: tests/ci/1-change
+          skip-comment: ${{ github.event.pull_request.head.repo.full_name != 'borchero/terraform-plan-comment' }}

README.md

@@ -44,7 +44,30 @@ GitHub Action to post the output of `terraform plan` to a pull request comment.
 
 ## Parameters
 
-This action provides a few input parameters that allow for customization:
+```yaml
+- uses: borchero/terraform-plan-comment@v2
+  with:
+    # GitHub token for API access (Required)
+    token: ""
+
+    # Path to the Terraform plan file (Required)
+    planfile: ""
+
+    # Command to execute the Terraform binary
+    terraform-cmd: terraform
+
+    # Directory where Terraform should be called
+    working-directory: "."
+
+    # Header for the PR comment
+    header: 📝 Terraform Plan
+
+    # Skip comments for empty plans
+    skip-empty: false
+
+    # Skip PR comment creation entirely. When enabled, the plan will still be available in the step summary
+    skip-comment: false
+```
 
 ### `token` (required)
 
@@ -76,3 +99,18 @@ The directory where the Terraform binary ought to be called. Defaults to `$GITHU
 
 The header that is used for the pull request comment posted by this action. Changing the default allows to distinguish
 multiple Terraform runs: each sticky pull request comment is identified by its header.
+
+### `skip-empty`
+
+Whether to skip posting a pull request comment when no changes need to be performed. Defaults to `false`.
+
+### `skip-comment`
+
+Whether to skip posting a pull request comment entirely. When enabled, the plan will still be available in the step
+summary.
+
+## Outputs
+
+This action provides the following output:
+
+- `markdown`: The raw markdown output of the terraform plan

action.yml

@@ -27,6 +27,13 @@ inputs:
     description: Whether to skip posting a pull request comment when no changes need to be performed.
     required: true
     default: "false"
+  skip-comment:
+    description: Whether to skip posting a pull request comment entirely.
+    required: true
+    default: "false"
+outputs:
+  markdown:
+    description: The raw markdown output of the terraform plan
 runs:
   using: node20
   main: dist/index.js

dist/index.js

@@ -44,7 +44,7 @@ function renderBody(plan: RenderedPlan): string {
   return body
 }
 
-export function renderComment({
+export function renderMarkdown({
   plan,
   header,
   includeFooter
@@ -59,9 +59,10 @@ export function renderComment({
   // Build footer
   let footer = ''
   if (includeFooter === undefined || includeFooter === true) {
-    footer =
-      `\n\n---\n\n_Triggered by @${github.context.actor},` +
-      ` Commit: \`${(github.context.payload as PullRequestEvent).pull_request.head.sha}\`_`
+    footer = `\n\n---\n\n_Triggered by @${github.context.actor}`
+    if (github.context.eventName === 'pull_request') {
+      footer += `, Commit: \`${(github.context.payload as PullRequestEvent).pull_request.head.sha}\`_`
+    }
   }
 
   return `## ${header}\n\n${body}${footer}`