-
Notifications
You must be signed in to change notification settings - Fork 17
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
[COMPLIANCE] Add copyright and license headers #130
Conversation
tools/go.mod
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might need to run a go mod tidy
on this? Was expecting terraform-plugin-docs
and copywrite
to be dependencies here
main.go
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Running into a similar thing with terraform-plugin-go
with it's own tools
directory. Adding tools
as it's own module will remove terraform-plugin-docs
from the root go.mod
next time you run go mod tidy
.
If the doc tool is removed from the root go.mod
, then you'll get this error running go generate
:
$ go generate ./...
no required module provides package github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs; to add it:
go get github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
main.go:20: running "go": exit status 1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've just switched to using separate directories for copywrite
and tools
. Seems to be behaving as desired.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool 👍🏻, I'll follow suit in terraform-plugin-go
Co-authored-by: Austin Valle <austinvalle@gmail.com>
…cifying directory for execution
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great to me 🚀 Excited for cleaner Go modules. 🧹
…ding go generate command for formatting terraform code to tools.go
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Closes #93
This PR introduces:
make generate
command that will auto-generate documentation and all copyright headers for this repo (hooks intogo generate
)CONTRIBUTING.md
on how to run license autogenerating commandscopywrite
module and add to dependabot