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

chore: fix terraform docs behavior #171

Merged
merged 1 commit into from
Nov 11, 2024
Merged

Conversation

d-costa
Copy link
Collaborator

@d-costa d-costa commented Nov 11, 2024

what

  • Remove version from docker run tf docs suggestion
  • Set lockfile: false in terraform-docs settings

why

  • When running the suggested command to locally generate docs, there is a difference in behavior between local and remote (gh action) results, since locally it has access to the terraform lockfile.
  • Since we do not commit the lockfile, it has no effect in gh workflows

references

@d-costa d-costa requested a review from a team as a code owner November 11, 2024 17:06
@github-actions github-actions bot added the github-actions Pull requests that update Github Actions code label Nov 11, 2024
Copy link
Member

@bschaatsbergen bschaatsbergen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@bschaatsbergen bschaatsbergen merged commit f80cc5b into main Nov 11, 2024
5 checks passed
@bschaatsbergen bschaatsbergen deleted the d-costa/terraform-docs branch November 11, 2024 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github-actions Pull requests that update Github Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants