lint: run goheader enforcing standardized Go header template #21821
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maintainer-s-little-helper
bot
added
the
dont-merge/needs-release-note-label
ti-mo
requested review from
nebril,
aspsk,
christarazi,
michi-covalent,
rolinh and
joestringer
ti-mo
added
the
release-note/misc
maintainer-s-little-helper
bot
removed
the
dont-merge/needs-release-note-label
ti-mo
force-pushed
the
tb/goheader-spdx
branch
from
1cb6383
to
ae6ebfd
Compare
rolinh
approved these changes
Oct 20, 2022
joestringer
requested changes
Oct 20, 2022
christarazi
approved these changes
Oct 20, 2022
joestringer
approved these changes
Oct 20, 2022
There was a problem hiding this comment.
Based on the discussions on my prior feedback, I don't think any changes to the content are necessary. It'd be nice to update the commit messages to highlight the background to the changes but otherwise this LGTM. Thanks for this, it's caught a bunch of missing licenses in source files 🎉
qmonnet
approved these changes
Oct 20, 2022
aspsk
approved these changes
Oct 21, 2022
ca451eb removed the use of SHT_REL(A), making this unnecessary. Signed-off-by: Timo Beckers <timo@isovalent.com>
These files were mostly taken from the Go stdlib. It seems like the Go project has also moved to a lean file header pointing to a single LICENSE file in the project. Retain only the relevant Go Authors copyright notice and point to the original files. Signed-off-by: Timo Beckers <timo@isovalent.com>
Signed-off-by: Timo Beckers <timo@isovalent.com>
Since we didn't have a linter to enforce a particular Go file header format, this patch adds one with a relatively simple structure. goheader can only match on a single block of // statements, so anything that cannot be encoded in the template needed to be moved to a separate block. For Hubble packages, 'Authors of Hubble' was kept as the primary tagline. Any other copyright notices were moved to subsequent blocks. Signed-off-by: Timo Beckers <timo@isovalent.com>
ti-mo
force-pushed
the
tb/goheader-spdx
branch
from
ae6ebfd
to
9180fc6
Compare
ti-mo
added
the
ready-to-merge
|
Hit some unrelated unit test flake in Travis, marking ready. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since we didn't have a linter to enforce a particular Go file header format, this patch adds one with a relatively simple structure.
goheader can only match on a single block of // statements, so anything that cannot be encoded in the template needed to be moved to a separate block.
For Hubble packages, 'Authors of Hubble' was kept as the primary tagline. Any other copyright notices were moved to subsequent blocks.
Fixes: #20769 (comment)