Closed leiicamundi closed 1 month ago
⚠️ Reminder: once it's merged, a followup PR should be done in order to pin the utility action (https://github.com/camunda/camunda-tf-eks-module/blob/214d0f32104f99796e3fafa333ed4e0eeeaa3262/.github/actions/eks-manage-cluster/action.yml#L117)
Thanks for the review and the highlights @Langleu ;) . After some consideration, I've opted for a solution that we will/should reuse in our other repositories if it works for you:
YAML Formatting: This is something we shouldn't have to worry about. I've added a pre-commit hook to handle this for us (https://github.com/jumanjihouse/pre-commit-hook-yamlfmt). In my opinion, this will ensure consistent YAML formatting across our files without the frustration of a linter, as it formats the files directly.
GHA Documentation: I've created a pre-commit hook that will eventually be extracted from this repository as a common resource. Based on https://github.com/npalm/action-docs, we now have an easy solution to generate documentation that handles required and default values automatically, so you won’t need to pay attention to those anymore.
Terraform Optional Values: During implementation, I was frustrated with having to redefine values that were already set in the module defaults. After some thought, I found a solution by allowing the action to accept a JSON object for overriding certain module variables.
Overall, these solutions automate processes and can be reused across repositories. Additionally, since some GHA documentation is now generated automatically, we face a similar issue to https://github.com/orgs/camunda/projects/87?pane=issue&itemId=75474510. I plan to extend this issue to include a bot that will, for each Renovate PR, perform a pre-commit run and commit any necessary modifications. This should address all our documentation update needs.
Hello @Langleu, thanks, indeed some formatting was broken I fixed it alongside the extraction of the pre-commit that generates the GHA Readmes (which can be used in our other repos now)
Once https://github.com/camunda/infraex-common-config/pull/54 is merged, I'll update the reference in this repo
Currently, 2 TODOs have been added:
I'm fine merging this PR and updating the references in once it's merged
implements https://github.com/camunda/team-infrastructure-experience/issues/307
it also add a renovate tag for aurora and pin some actions