terraform-pr-summary

README

terraform-pr-summary

A GitHub Action which adds a comment to a GitHub pull request with a summary of Terraform changes

Example

👉 Plan: 1 to add, 2 to change, 1 to destroy.

🛠️ Created:
random_password.foo

🔀 Updated:
module.this.module.mysql.aws_db_instance.this

♻️ Replaced:
module.this.module.app.aws_ecs_task_definition.this

❌ Deleted:
module.this.module.ui.aws_route53_record.this

Example Usage

jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - uses: hashicorp/setup-terraform@v1.3.2

      - uses: champ-oss/terraform-pr-summary
        if: github.event_name == 'pull_request'
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

Parameters

Parameter	Required	Description
token	false	GitHub Token or PAT

Contributing