WIP: Docs fixer in GitHub Actions

[Vlaaaaaaad]

PR o'clock

Creating this PR to start a discussion on wether this is desired or not. The user experience for this is not perfect.

Description

There are checks for formatting and docs, but no easy way to fix it. To get the docs up to date/ fix formatting contributors have to setup pre-commit properly.

This PR adds a GitHub Action that runs pre-commit and commits the result back.

Example workflow:

• PR is open, all checks are green
• commits are added, docs are now out of date
• /fix comment on the PR Review( not on the Conversation as GitHub Actions has... limitation about events and what data is in there -- like the branch name)
• new commit is added to the branch fixing the docs

There is a downside to this though: by default when using secrets.GITHUB_TOKEN no actions will run on commits made by GitHub Actions. This is bad especially because checks are required for merging.
An ugly but working fix is to use a Personal Access Token as the secret instead of the default GITHUB_TOKEN. What I see in most GitHub orgs is a bot user which is used for this.

An example with secrets.GITHUB_TOKEN can be seen here.
An example with secrets.BOT_PERSONAL_ACCESS_TOKEN can be seen here.

⚠️ Weirdly enough, the terraform_docs had different results when the check was running on macOS vs when running on Linux. I have no idea where to even start to debug this. ⚠️

Checklist

• terraform fmt and terraform validate both work from the root and examples/* directories
• CI tests are passing
• I've added my change to CHANGELOG.md and highlighted any breaking changes
• README.md has been updated after any changes to variables and outputs. See https://github.com/terraform-aws-modules/terraform-aws-eks/#doc-generation

[Vlaaaaaaad]

🤦‍♂ this should've been a Draft PR as I wanted to discuss what's in here first. Can't make it a draft now unfortunately.

[RothAndrew]

IMO, a better pattern would be to fail the build if the user hasn't done the required pre-commit stuff.

[Vlaaaaaaad]

The build does already fail if the pre-commit checks don't pass. The proposed action would help fix those issues without forcing a contributor to setup pre-commit.

[barryib]

I'm agree with @RothAndrew. I think the setup process is simple enough. To install pre-commit hooks, it's just matter of brew install pre-coomit or pip install pre-commit. And this can be added in the CONTRIBUTING guide. Running pre-commit can be done even manually (if you don't want to pre-commit install) with pre-commit run -a before pushing your contribution.

This work is great and it would have a lot of benefit on a complicated workflow or setup.

[Vlaaaaaaad]

Well, based on feedback I am closing the PR. It makes sense considering the workflow here is rather short.

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.