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.

Sign up for GitHub

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

Jump to bottom

Add 'resources.md.tmpl' to allowed files? #182

Closed
norrland opened this issue Sep 9, 2022 · 1 comment · Fixed by #341 · May be fixed by #184
Closed

Add 'resources.md.tmpl' to allowed files? #182

norrland opened this issue Sep 9, 2022 · 1 comment · Fixed by #341 · May be fixed by #184

Comments

@norrland
Copy link

norrland commented Sep 9, 2022 •
edited

terraform-plugin-docs/internal/provider/validate.go

Line 55 in b7abf70

checkAllowedFiles(

When running tfplugindocs validate I get an error if I have a generic resources template.

$ tfplugindocs validate
detected templates directory, running checks...
templates/resources.md.tmpl: file "resources.md.tmpl" is not allowed
Error executing command: unable to validate website: invalid templates directory

When looking at the README, it looks like this should be accepted.
jacobbednarz added a commit to jacobbednarz/terraform-plugin-docs that referenced this issue Sep 12, 2022
@jacobbednarz
validate: allow resources.md.tmpl and data-sources.md.tmpl to pas…
ade0cc9 
…s validation

Closes hashicorp#182
@jacobbednarz jacobbednarz mentioned this issue Sep 12, 2022
Open
@jacobbednarz
Copy link
Contributor

#184 takes a pass at addressing this however, i have a feeling that the validate command is lacking quite a bit of context and will need some love to get it covering all cases (see examples validation for instance)

@SBGoods SBGoods mentioned this issue Mar 5, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@jacobbednarz @norrland