feat: add job summary (#36)

* feat: this small feature adds the terraform plan output to the workflow job summary giving an additional place to review the plan outside of the PR comment

.github/workflows/action-test.yml

@@ -27,6 +27,7 @@ jobs:
         with:
           json-file: test-data/tf_test.json
           expand-comment: 'true'
+          include-plan-job-summary: 'true'
 
       - name: Test PR Commenter with no changes
         uses: ./

.gitignore

@@ -1,3 +1,6 @@
+# dist release output
+dist
+
 # Logs
 logs
 *.log

README.md

@@ -35,19 +35,31 @@ Implementing this Action is _super_ simple and the comments are consise and easy
 ## Example usage
 Single plan file:
 ```yaml
-uses: liatrio/terraform-change-pr-commenter@v1.3.3
+uses: liatrio/terraform-change-pr-commenter@v1.4.0
 with:
   json-file: my-tfplan.json
   expand-comment: 'true' 
 ```
 Multiple plan files:
 ```yaml
-uses: liatrio/terraform-change-pr-commenter@v1.3.3
+uses: liatrio/terraform-change-pr-commenter@v1.4.0
 with:
   json-file: |
     core-infra-tfplan.json
     shared-infra-tfplan.json
 ```
+Include plan output to the Actions workflow job summary:
+```yaml
+uses: liatrio/terraform-change-pr-commenter@v1.4.0
+with:
+  json-file: my-tfplan.json
+  expand-comment: 'true'
+  include-plan-job-summary: 'true'
+```
+**Note:** 
+- When `include-plan-job-summary = true`, if the action is executed in non-Pull Request workflows, the plan output will also be posted to the job summary of that run. If you do not wish to have this behavior, apply conditional logic to your workflow file.
+#### Example Job Summary Output
+![Plan output job summary](assets/plan-output-job-summary.png)
 
 ## Terraform Configuration / Known Issues
 #### Known issue when including the [Terraform Wrapper script](https://github.com/hashicorp/setup-terraform#inputs)

action.yml

@@ -16,6 +16,10 @@ inputs:
     description: If true, expand the details comment by default
     required: false
     default: 'false'
+  include-plan-job-summary:
+    description: If true, add the results of the plan to the workflow job summary
+    required: false
+    default: 'false'
 runs:
   using: node16
   main: dist/index.js