feat: minimize previous comment

.github/workflows/action-test.yml

@@ -24,6 +24,17 @@ jobs:
             test-data/tf_test2.json
             test-data/tf_test3.json
 
+      - name: Test PR comment hiding
+        uses: ./
+        with:
+          json-file: |
+            test-data/tf_test.json
+            test-data/tf_test2.json
+            test-data/tf_test3.json
+          hide-previous-comments: true
+          comment-header: "Same as previous but previous comment should be hidden."
+
+
       - name: Test PR Comment Expand feature
         uses: ./
         with:

README.md

@@ -12,25 +12,73 @@ Implementing this Action is _super_ simple and the comments are consise and easy
 - Display changes in a Terraform plan without posting larger sections of the plan change log. This approach will, in most cases, avoid the situation where plan contents are too large for a single PR comment. 
 - Collapsed as a summary by default, when expanded, the comment is broken up into sections for  deletion, creation, and resource changes. The changes are also color-coded to help draw attention to each proposed modification.
 - This JavaScript GitHub Action runs directly on a host runner and executes faster than a Docker container Action.
+- Possibility to add the output to your workflow summary.
+- Possibility to hide previous comments generated by this action.
+- Possibility to not create any comments in case there are no infrastructure changes.
+- Customize the header and the footer of the generated output.
 
 ### Example Comment
 ![terraform-changes](./assets/terraform-changes.png)
 
 ## Inputs
 
-## `expand-comment`
+### `json-file`
+
+**Optional** Defaults to `tfplan.json`
+
+- The location of the JSON file created by running `terraform show -no-color -json tfplan.plan > tfplan.json` (Or whatever you choose to name your plan or json outputs)
+
+- Multiple files can be provided using a text block.
+
+### `github-token`
+
+**Optional** Boolean defaults to `${{github.token}}`
+
+- Used to authenticate with the GitHub API.
+
+### `expand-comment`
 
 **Optional** Boolean defaults to `false`
 
 - Will expand the changes in comments by default rather than having them collapsed beneath the summary
 
-### `json-file`
+### `include-plan-job-summary`
 
-**Optional** Defaults to `tfplan.json`
+**Optional** Defaults to `false`
 
-- The location of the JSON file created by running `terraform show -no-color -json tfplan.plan > tfplan.json` (Or whatever you choose to name your plan or json outputs)
+- Will write the plan output to the workflow summary.
 
-- Multiple files can be provided using a text block.
+- The workflow summary will still be set when running this action outside of a PR context.
+
+### `comment-header`
+
+**Optional** Defaults to `Terraform Plan Changes`
+
+- Will set the header of the PR comment and/or workflow summary.
+
+### `comment-footer`
+
+**Optional** Defaults to `""`
+
+- Will set a footer of the PR comment and/or workflow summary.
+
+### `include-workflow-link`
+
+**Optional** Defaults to `false`
+
+- Will include a link back to the workflow in the PR comment and/or workflow summary.
+
+### `quiet`
+
+**Optional** Defaults to `false`
+
+- Will not create a PR comment when there are no infrastructure changes.
+
+### `hide-previous-comments`
+
+**Optional** Defaults to `false`
+
+- Will hide/minimize all previous comments generated by this action.
 
 ## Example usage
 Single plan file:
@@ -61,6 +109,29 @@ with:
 #### Example Job Summary Output
 ![Plan output job summary](assets/plan-output-job-summary.png)
 
+## Example usage with OpenTofu
+
+To use this action with OpenTofu you need to initialize OpenTofu without the wrapper, like discussed in the `known issues` below.
+
+But you also need to convert the planfile to a JSON planfile using the `tofu show -json` command.
+
+```yaml
+  - uses: opentofu/setup-opentofu@v1
+    with:
+      tofu_wrapper: false
+
+  - name: Create planfile
+    run: tofu plan -no-color -out=./.planfile
+
+  - name: Convert planfile to JSON planfile
+    run: tofu show -json ./.planfile >> ./my-planfile.json
+
+  - name: Create PR comment
+    uses: liatrio/[email protected]
+    with:
+      json-file: my-planfile.json
+```
+
 ## Terraform Configuration / Known Issues
 #### Known issue when including the [Terraform Wrapper script](https://github.com/hashicorp/setup-terraform#inputs)
 - Execution may error with `Error: Unexpected token c in JSON at position 1`

action.yml

@@ -36,6 +36,10 @@ inputs:
     description: Skips the comment if there are no changes
     required: false
     default: false
+  hide-previous-comments:
+    description: Hides privious comments on the PR
+    required: false
+    default: false
 runs:
   using: node20
   main: dist/index.js