Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ignore lockfiles while building Terraform docs #383

Merged
merged 1 commit into from Mar 4, 2024

Conversation

Nuru
Copy link
Sponsor Contributor

@Nuru Nuru commented Mar 4, 2024

what

  • Ignore lockfiles while building Terraform docs

why

  • By default, terraform-docs takes into account any version pinning present in the automatically generated .terraform.lock.hcl. However, Cloud Posse modules do not use the lock files for version pinning, which means that different people can get different results when creating the documentation, which causes problems. By ignoring the lock files, we make the documentation easier to reproduce.

@Nuru Nuru requested a review from a team as a code owner March 4, 2024 22:59
@Nuru Nuru requested review from hans-d and removed request for goruha and aknysh March 4, 2024 22:59
@Nuru Nuru enabled auto-merge (squash) March 4, 2024 23:00
@hans-d
Copy link

hans-d commented Mar 4, 2024

@hans-d
Copy link

hans-d commented Mar 4, 2024

@Nuru needs cloudposse/engineering, i'm not yet part of that elite team ...

@Nuru Nuru merged commit 4ce029d into master Mar 4, 2024
13 checks passed
@Nuru Nuru deleted the terraform-docs-ignore-lockfiles branch March 4, 2024 23:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants