Repository navigation
Generate Terraform module READMEs in CI - #224
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #208
Adds incubator's
terraform-docsjob toterraform-plan.yaml, copied verbatim, so the Terraform module READMEs are regenerated on every PR that changes a.tffile..terraform.docs.ymlconfigs. The job runs without a config, and terraform-docs would never auto-discover these files anyway because of how they are named.<!-- BEGIN_TF_DOCS -->, so inject mode doesn't overwrite it. The root README's Directory Structure list is rewritten: its file links pointed at module folders, and half the files were missing.aws-gha-oidc-providersgets its first README, with a heading..tffile, so the new job will not run on it. A second local run changes nothing, so the job's first real run should have nothing to push. The regenerated tables also correct stale entries: users that have been removed, the missing CloudTrail lifecycle resources, andaws-groups'policy_arntype.The squash-merge message source was switched to PR title/body beforehand, so the docs job's
[skip ci]can't leak into the commit onmainand skip the apply.After merge: check that the commit on
mainhas no[skip ci]and thatApply Terraform changes on mergeran.