Enforce SPDX headers in Go files with goheader linter #1388
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
✅ Deploy Preview for tetragon ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
This commit changes Apache-2 license headers to use SPDX. It was achieved with
a regex replace in VSCode:
```
// Copyright \d{4}(-\d{4})? Authors of (Cilium|Hubble|Tetragon)
//
// Licensed under the Apache License, Version 2.0 \(the "License"\);
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
```
replaced by
```
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of $2
```
followed by:
```
$ make codegen
$ make generate
```
Signed-off-by: Anna Kapuscinska <[email protected]>
This commit adds an SPDX license header to Go files that didn't have it. It was achieved with a regex replace in VSCode: ``` ^(?<![\s\S\r])((?!// SPDX-License-Identifier: Apache-2.0)) ``` replaced by ``` // SPDX-License-Identifier: Apache-2.0 // Copyright Authors of Tetragon ``` followed by: ``` $ make codegen $ make generate ``` Signed-off-by: Anna Kapuscinska <[email protected]>
This will enforce that all Go files start with ``` SPDX-License-Identifier: Apache-2.0 Copyright Authors of Tetragon|Cilium|Hubble ``` Signed-off-by: Anna Kapuscinska <[email protected]>
lambdanis
force-pushed
the
pr/lambdanis/spdx-linter
branch
from
d76e342
to
5670055
Compare
michi-covalent
approved these changes
Aug 26, 2023
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.
The first two commits update many Go files to use the SPDX header consistently. See commit messages for how it was done.
The last commit adds goheader linter to
.golangci-lintto enforce these headers.Let me know if something should look differently. I found missing headers in some PRs recently, so decided to automate this check instead of being a robot.