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: update docs #21

Merged
merged 4 commits into from
Feb 14, 2023
Merged

Conversation

stephanGarland
Copy link
Contributor

  • Updates docs to include a brief explanation of .tfbuddy.yaml syntax and doublestar
  • Adds mention of the necessity of Poetry's --no-root flag when installing
  • Minor whitespace cleanup

…lestar

TF Buddy uses the doublestar Go library, which is bash-inspired.
This adds a brief explanation of the various ways to configure watched directories.

Signed-off-by: Stephan Garland <stephan.garland@zapier.com>
Since Poetry is being used here solely to build mkdocs, if the --no-root
option is omitted when installing, Poetry will emit a ValueError.
See this Issue: python-poetry/poetry#2458 (comment)

Signed-off-by: Stephan Garland <stephan.garland@zapier.com>
* `terraform/production/**` - anything that has `terraform/production` as an ancestor
* `terraform/staging/**/*.tf` - any Terraform files that have `terraform/staging` as an ancestor
* `terraform/staging/{foo,bar}/**` - anything that has `terraform/staging/foo` or `terraform/staging/bar` as an ancestor
* `terraform/staging/**/[^0-9]*` - anything that has `terraform/staging` as an ancestor and does _not_ start with an integer
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't actually know how doublestar handles conflicting rules, e.g. if there's a file named terraform/staging/foo/2023-01-01.txt, is that matched due to the 4th rule coming before the 5th, or does the 5th negate the 4th?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'll add a unit test to validate this behaviour

@sl1pm4t sl1pm4t merged commit d0f1160 into zapier:main Feb 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants