ahmadnassri / action-terraform-report Goto Github PK

GitHub security best practices suggest putting commenting workflows separate (details)

I have my workflow output the json and txt diffs as artifacts, and would like to call this action from a dependent workflow with those files - but this isn't currently possible because this action fails to get the pull request metadata from the dependent workflow.

Can we add an optional input for pull request number?

Many thanks for the awesome plugin!

Must use app

Utilizing v3.2.5, and the following configuration -- looks a little funky because this is a reusable workflow, and we have multiple sets of terraform deployments per repository:

# [...]
      - name: terraform-plan
        if: ${{ !inputs.destroy && !inputs.apply }}
        run: |
          terraform -chdir="${{ inputs.deployment_name }}" plan \
            -out terraform.plan \
            -var deployment_name="${{ inputs.deployment_name }}" \
            -var environment="${{ inputs.environment }}" ${{ secrets.terraform_args }}

          terraform -chdir="${{ inputs.deployment_name }}" \
            show -no-color terraform.plan > "${{ github.workspace }}/${{ inputs.deployment_name }}.plan.text"

          terraform -chdir="${{ inputs.deployment_name }}" \
            show -json terraform.plan > "${{ github.workspace }}/${{ inputs.deployment_name }}.plan.json"
      - uses: ahmadnassri/action-terraform-report@54b9349621e8310146a87b8c636b8d5fbab5767e
        if: ${{ github.event_name == 'pull_request' && !inputs.destroy && !inputs.apply }}
        with:
          terraform-text: "${{ github.workspace }}/${{ inputs.deployment_name }}.plan.text"
          terraform-json: "${{ github.workspace }}/${{ inputs.deployment_name }}.plan.json"
          custom-header: ":robot: terraform-plan: ${{ inputs.deployment_name }} (env: ${{ inputs.environment }})"
          show-plan: true
          show-diff: false
          remove-stale-reports: true
# [...]

Re-running the action twice results in a duplicate set of comments in the PR, and it doesn't remove the previous comments. Not sure if this is due to this logic and using a custom header, maybe?

Duplicate comment example:

To also add, the second run doesn't show any warnings/errors/etc about not being able to remove comments. This is the result of the 2nd run that added the 2nd comment:

Thoughts on what the issue may be? Am I misunderstanding what remove-stale-reports is used for?

Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: ahmadnassri/action-terraform-report@v3. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.

This looks promising! ❤️

Would you be up for adding/showing an example (output/screenshot) of what the user experience is when using this action?

Issue: Show the wrong plan in header details.

As you can see above, add value is 3, and destroy value is 4. but the actual plan details are as per below.

Thanks

Would it be possible to have some additional context such that we could add some custom information to the Report Header specifically

🤖 Terraform Report <- custom information here ->

We run our terraform for different environments/regions it would be nice to have the region/env information right at the top?

I would be willing to submit a PR, if you think that feature is acceptable.

The terraform.json is a valid json but still getting an error as -
Unhandled error: Error: invalid Terraform Plan JSON data

How can we troubleshoot ?

There is a limit on the github api where if the terraform delta is over 65k chars, that the Github api cant handle the comment request.

It would be amazing if this action could trim the plan to be within the limiit and indicate in the comment that its been truncated.

I have plan with 10 resources to recreate. action-terraform-report doesn't show destroyed resources for recreated/replaced resources in comment message.

I expect this output:

Plan: 28 to add, 19 to change, 10 to destroy

Additional option to show recreated resourced like this:

Plan: 18 to add, 19 to change, 0 to destroy, 10 to recreate