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

[angela-lee1]

ETA 4/5 eod

[angela-lee1]

Sorry, I got distracted by other work. I will use late Thursday afternoon till the end of this week to refine and test the code.

[ExperimentsInHonesty]

@awlFCCamp Please provide update

1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
2. Blockers: "Difficulties or errors encountered."
3. Availability: "How much time will you have this week to work on this issue?"
4. ETA: "When do you expect this issue to be completed?"
5. Pictures or links* (if necessary): "Add any pictures or links that will help illustrate what you are working on."

• remember to add links to the top of the issue if they are going to be needed again.

If you want to give this issue back, just unassign yourself from it and stick it back into new issue approval

[angela-lee1]

Sorry, I got distracted by other events, unassigning myself.