-
Notifications
You must be signed in to change notification settings - Fork 32
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 #292
Conversation
.copywrite.hcl
Outdated
# Release Engineering tooling configuration | ||
".release/*.hcl", | ||
|
||
# Proto and protoc generated files |
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.
Along with the auto-generated files, I also ignored the .proto
file, is that okay?
I believe comments would persist to the auto-generated file as well if we wanted to just ignore the auto-generated files only, i.e. *.pb.go
and then I can run a make protoc
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.
Hm the .proto
files probably should have the copyright headers as they are intellectual property related. 👍 I thought the issue we saw elsewhere was that the comment would be injected into the middle of the .pb.go
file instead of the top like copywrite
wants, but maybe that's mistaken! grpc/grpc-go#5540 seems to suggest from the testing files that both protoc-gen-go and protoc-gen-go-grpc can put the comments at the top, maybe?
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 added an ignore just for the .pb.go
files and then ran a make protoc
:
$ make generate
cd tools; go generate ./...
Using license identifier: MPL-2.0
Using copyright holder: HashiCorp, Inc.
Exempting the following search patterns:
.changes/unreleased/*.yaml
.changie.yaml
.github/ISSUE_TEMPLATE/*.yml
.github/labeler-*.yml
.golangci.yml
.goreleaser.yml
.release/*.hcl
tfprotov5/internal/tfplugin5/*.pb.go
tfprotov6/internal/tfplugin6/*.pb.go
The following files are missing headers:
2023-06-05T12:31:48.015-0400 [INFO] cli: tfprotov5/internal/tfplugin5/tfplugin5.proto modified
2023-06-05T12:31:48.016-0400 [INFO] cli: tfprotov6/internal/tfplugin6/tfplugin6.proto modified
795afc4
to
dc59e48
Compare
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 good to me 🚀
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 good to me 🚀
Co-authored-by: Brian Flad <bflad417@gmail.com>
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 #259
This PR introduces:
tools
module, add to dependabot, and move GRPC program totools
module dependenciesmake generate
command that will auto-generate all copyright headers for this repo (hooks intogo generate
)make tools
command to simplify the installation process of the Go specific tooling formake protoc
targetmake tools
commandCONTRIBUTING.md
on how to run license autogenerating commands