Automate running terraform docs 66

[angela-lee1]

Fixes #66

We need to automate running Terraform Docs whenever a .tf file is changed inside of a Terraform directory. I have changed the region in terraform-incubator/people-depot/dev/main.tf to trigger. I will change back later.

[angela-lee1]

@chelseybeck @freaky4wrld This is my first draft. Please take a look at it and give feedback for revision. Thank you.

[freaky4wrld]

@awlFCCamp I'm not that much experienced with terraform, but I can definitely review it if you provide me details what changes you've made. Or if @chelseybeck tells me where to start from :)

[freaky4wrld]

Hey @awlFCCamp I think the idea is to make changes to the terraform-plan.yml , and add the new GHA triggers to it... the file terraform-docs.yml looks fine to me. Moreover it can only be observed more when you have your test-environment ready for it!!

Though I'm not sure how you made changes to README.md of different projects, did you use terraform-docs to do it manually ?

[angela-lee1]

@freaky4wrld Thank you! Chelsey suggested I put changes into a separate file for testing. I will ask her if I need to revert. I made all the changes through the terraform-docs.yml file. I set up testing in my branch, can you elaborate more on "when you have your test-environment ready for it!!" Sorry, My first GitHub action, I am excited but also a bit unsure.

[freaky4wrld]

@freaky4wrld Thank you! Chelsey suggested I put changes into a separate file for testing. I will ask her if I need to revert. I made all the changes through the terraform-docs.yml file. I set up testing in my branch, can you elaborate more on "when you have your test-environment ready for it!!" Sorry, My first GitHub action, I am excited but also a bit unsure.

I was asking if you have tested the GHA in your local repo, if it works fine in the local repo.... it will work here as well, this is the link to the guide in case you need it https://github.com/hackforla/website/wiki/Hack-for-LA's-GitHub-Actions

[angela-lee1]

@freaky4wrld Thank you. It worked last week https://github.com/awlFCCamp/incubator/actions/runs/8725012627, but it failed here. I will look into it later today.

[chelseybeck]

curious about this change. this is to a main.tf file, not a readme...and the region should prob be us-west-2

[angela-lee1]

I changed it to trigger the workflow. I probably should have noted that in the PR.

[chelseybeck]

we don't want to run terraform docs in directories that don't have a tf file. this is one of those instances, but we do want to run it inside of the other directories in terraform-modules. i wonder if there's a way to refactor this a little where we get a list of the directories and then loop through it

[angela-lee1]

Thank you, Chelsey! Great idea, will look into it.

[angela-lee1]

will make another one from a different branch