defenseunicorns / delivery-aws-iac

Apache License 2.0
16 stars 5 forks source link

Ability to run `terraform-docs` automatically and commit any changes #283

Closed RothAndrew closed 1 year ago

RothAndrew commented 1 year ago

Persona

I'm a maintainer of this repo

Description

I'd like the ability to kick off an automated workflow that will run terraform docs on my PR and commit any changes that were made. My favorite place to pull examples from, CloudPosse, does this with a Slash Command Dispatch called /rebuild readme but they also do some other stuff that is quite different. Perhaps something like /update readme would be more appropriate?

Use Case

It takes a lot of time to update every Renovate PR that fails the terraform-docs pre-commit check. Currently I have to pull down the branch, run pre-commit run -a locally, and push up the changes.

Impact

It will continue to take a lot of time to update Renovate PRs

Completion

Additional Context

none