Automate running Terraform Docs commands in CI/CD

[chelseybeck]

Overview

We need to automate running Terraform Docs commands in our CI/CD pipeline whenever .tf files are changed inside of a Terraform directory, so that ?????

Details

For instance, if a .tf file changes inside of terraform-incubator/access-the-data (or any of its subdirectories), README.md file(s) need to be updated using Terraform Docs.

Action Items

• Read over the Terraform Docs documentation to understand how the templates are used to generate README.md files
• Read over the Terraform Docs GitHub Action documentation to understand how to integrate the necessary steps into our CI/CD pipeline
• Make changes to terraform-plan.yml. This should be able to be one job added as shown in the Terraform Docs GitHub Action

Resources/Instructions

Terraform Docs documentation
Terraform Docs GitHub Action