Merge pull request #16 from GetTerminus/dpr-update-commenter

feat: pr-commenter v3

Author: dreinhardt89

.github/workflows/release-beta.yaml

@@ -1,9 +1,7 @@
 name: Release Beta
 
 on:
-  push:
-    branches-ignore:
-      - master
+  pull_request:
 
 jobs:
   release-beta:
@@ -13,7 +11,7 @@ jobs:
       - name: Set Beta Git tag
         uses: weareyipyip/walking-tag-action@v2
         with:
-          tag-name: v2-beta
+          tag-name: v3-beta
           tag-message: The current beta is based on this commit
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yaml

@@ -1,26 +1,22 @@
 name: Test
 
 on:
-  workflow_run:
-    workflows: [Release Beta]
-    types:
-      - completed
+  pull_request:
 
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   TERRAFORM_VERSION: "1.4.6"
   TF_WORKSPACE: "testing"
-  USE_BETA_VERSION: "true"
   COMMENTER_DEBUG: "true"
   GH_ACCEPT_HEADER: "Accept: application/vnd.github+json"
   GH_AUTH_HEADER: "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}"
   GH_API_VERSION: "X-GitHub-Api-Version: 2022-11-28"
   GH_COMMENT_URL: https://api.github.com/repos/GetTerminus/terraform-pr-commenter/issues/${{ github.event.number }}/comments
+  TESTING: "false" #set to false when finished testing
 
 jobs:
   set-outputs:
     name: Set Outputs
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     runs-on: ubuntu-latest
     outputs:
       tf_fmt_fail: ${{ steps.file_outputs.outputs.tf_fmt_fail }}
@@ -29,8 +25,10 @@ jobs:
       tf_plan_fail_partial: ${{ steps.file_outputs.outputs.tf_plan_fail_partial }}
       tf_plan_success_no_changes: ${{ steps.file_outputs.outputs.tf_plan_success_no_changes }}
       tf_plan_success_with_changes: ${{ steps.file_outputs.outputs.tf_plan_success_with_changes }}
+      tf_plan_success_with_outputs: ${{ steps.file_outputs.outputs.tf_plan_success_with_outputs }}
       tf_plan_success_long: ${{ steps.file_outputs.outputs.tf_plan_success_long }}
       tf_validate_fail: ${{ steps.file_outputs.outputs.tf_validate_fail }}
+      tflint_fail: ${{ steps.file_outputs.outputs.tflint_fail }}
     strategy:
       matrix:
         filenames:
@@ -40,15 +38,19 @@ jobs:
           - "tf_plan_fail_partial"
           - "tf_plan_success_no_changes"
           - "tf_plan_success_with_changes"
+          - "tf_plan_success_with_outputs"
           - "tf_plan_success_long"
           - "tf_validate_fail"
+          - "tflint_fail"
     steps:
       - uses: actions/checkout@v3
+        if: ${{ env.TESTING == 'true' }}
       - name: Set Test Outputs
+        if: ${{ env.TESTING == 'true' }}
         id: file_outputs
         run: |
           EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
-          
+
           #have to truncate so we don't get an "argument list too long" error
           if [[ "${{ matrix.filenames }}" == "tf_plan_success_long" ]]; then
             OUTPUT=$(cat ./testing/text-files/${{ matrix.filenames }}.txt)
@@ -62,18 +64,18 @@ jobs:
   # To test other scenarios please change the below variables as necessary.
   commenter-test:
     name: Test Commenter
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     runs-on: ubuntu-latest
     needs: set-outputs
     steps:
       - uses: actions/checkout@v3
+        if: ${{ env.TESTING == 'true' }}
       - name: Test
-        uses: GetTerminus/terraform-pr-commenter@v3-beta
+        if: ${{ env.TESTING == 'true' }}
+        uses: GetTerminus/terraform-pr-commenter@v3-beta #set to your branch for testing and switch back to v3-beta when done.
         with:
           commenter_type: plan
           # Should only be setting commenter_input or commenter_plan_path (commenter_plan_path only for plan commenter type)
-          #commenter_input: ${{ needs.set-outputs.outputs.tf_plan_fail }}
-          commenter_plan_path: ./testing/text-files/tf_plan_success_with_changes.txt
-          commenter_exitcode: 1
-          terraform_version: ${{ env.TERRAFORM_VERSION }}
-          use_beta_version: ${{ env.USE_BETA_VERSION }}
+          commenter_input: ${{ needs.set-outputs.outputs.tf_plan_success_with_outputs }}
+          #commenter_plan_path: ./testing/text-files/tf_plan_success_with_outputs.txt
+          commenter_exitcode: 2
+          use_beta_version: "true"

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## v3.0.0
+- Add support for tflint.
+- Remove requirement to run `terraform show` internally and depend on either direct input or directing the `terraform plan` output to a txt file.
+- Add support for adding partial plan to the comment on failure.
+
+## v2.0.0
+- Run `terraform show` internally to bypass github 64k limit.
+- Paginate comments that are greater than 64k characters and delete corresponding paginated comments on each successive rerun.
+- Temporarily swap out red `-` so yaml arrays aren't confused with diff-removal lines.
+
 ## v1.5.0
 
 - Bump to Terraform v1.0.6 internally (only affects `fmt`)

Dockerfile

@@ -1,13 +1,13 @@
-ARG TERRAFORM_VERSION=1.0.6
+ARG TERRAFORM_VERSION=1.4.6
 FROM hashicorp/terraform:${TERRAFORM_VERSION}
 
-LABEL repository="https://github.com/robburger/terraform-pr-commenter" \
-      homepage="https://github.com/robburger/terraform-pr-commenter" \
-      maintainer="Rob Burger" \
+LABEL repository="https://github.com/GetTerminus/terraform-pr-commenter" \
+      homepage="https://github.com/GetTerminus/terraform-pr-commenter" \
+      maintainer="Terminus Software" \
       com.github.actions.name="Terraform PR Commenter" \
-      com.github.actions.description="Adds opinionated comments to a PR from Terraform fmt/init/plan output" \
+      com.github.actions.description="Adds comments to a PR from Terraform fmt/init/plan/tflint output." \
       com.github.actions.icon="git-pull-request" \
-      com.github.actions.color="purple"
+      com.github.actions.color="blue"
 
 RUN apk add --no-cache -q \
     bash \
@@ -16,6 +16,10 @@ RUN apk add --no-cache -q \
     jq
 
 ADD entrypoint.sh /entrypoint.sh
+ADD /handlers /handlers
+ADD /utilities /utilities
 RUN chmod +x /entrypoint.sh
+RUN chmod +x /handlers
+RUN chmod +x /utilities
 
 ENTRYPOINT ["/entrypoint.sh"]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Rob Burger
+Copyright (c) 2023 Terminus Software
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal