SkyWalking Eyes
A full-featured license tool to check and fix license headers and resolve dependencies' licenses.
Usage
You can use License-Eye in GitHub Actions or in your local machine.
GitHub Actions
To use License-Eye in GitHub Actions, add a step in your GitHub workflow.
- name: Check License Header
uses: apache/[email protected] # always prefer to use a revision instead of `main`.
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # needed only when you want License-Eye to comment on the pull request.
Add a .licenserc.yaml in the root of your project, for Apache Software Foundation projects, the following configuration should be enough.
header:
license:
spdx-id: Apache-2.0
copyright-owner: Apache Software Foundation
paths-ignore:
- 'dist'
- 'licenses'
- '**/*.md'
- 'LICENSE'
- 'NOTICE'
comment: on-failure
NOTE: The full configurations can be found in the configuration section.
Docker Image
$ docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header check
$ docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix
Compile from Source
$ git clone https://github.com/apache/skywalking-eyes
$ cd skywalking-eyes
$ make build
Check License Header
$ bin/darwin/license-eye -c test/testdata/.licenserc_for_test_fix.yaml header check
INFO Loading configuration from file: test/testdata/.licenserc_for_test.yaml
INFO Totally checked 23 files, valid: 8, invalid: 8, ignored: 7, fixed: 0
ERROR The following files don't have a valid license header:
test/testdata/include_test/without_license/testcase.go
test/testdata/include_test/without_license/testcase.graphql
test/testdata/include_test/without_license/testcase.java
test/testdata/include_test/without_license/testcase.md
test/testdata/include_test/without_license/testcase.py
test/testdata/include_test/without_license/testcase.sh
test/testdata/include_test/without_license/testcase.yaml
test/testdata/include_test/without_license/testcase.yml
exit status 1
Fix License Header
$ bin/darwin/license-eye -c test/testdata/.licenserc_for_test_fix.yaml header fix
INFO Loading configuration from file: test/testdata/.licenserc_for_test_fix.yaml
INFO Totally checked 16 files, valid: 7, invalid: 8, ignored: 1, fixed: 8
Resolve Dependencies' licenses
$ bin/darwin/license-eye -c test/testdata/.licenserc_for_test_check.yaml dep resolve
INFO GITHUB_TOKEN is not set, license-eye won't comment on the pull request
INFO Loading configuration from file: test/testdata/.licenserc_for_test_check.yaml
WARNING Failed to resolve the license of dependency: gopkg.in/yaml.v3 cannot identify license content
Dependency | License
------------------------------------------- | ------------
github.com/bmatcuk/doublestar/v2 | MIT
github.com/sirupsen/logrus | MIT
golang.org/x/sys/unix | BSD-3-Clause
github.com/spf13/cobra | Apache-2.0
github.com/spf13/pflag | BSD-3-Clause
vendor/golang.org/x/net/dns/dnsmessage | BSD-3-Clause
vendor/golang.org/x/net/route | BSD-3-Clause
golang.org/x/oauth2 | BSD-3-Clause
golang.org/x/oauth2/internal | BSD-3-Clause
vendor/golang.org/x/crypto/cryptobyte | BSD-3-Clause
vendor/golang.org/x/crypto/cryptobyte/asn1 | BSD-3-Clause
golang.org/x/net/context/ctxhttp | BSD-3-Clause
vendor/golang.org/x/crypto/chacha20poly1305 | BSD-3-Clause
vendor/golang.org/x/crypto/chacha20 | BSD-3-Clause
vendor/golang.org/x/crypto/internal/subtle | BSD-3-Clause
vendor/golang.org/x/crypto/poly1305 | BSD-3-Clause
vendor/golang.org/x/sys/cpu | BSD-3-Clause
vendor/golang.org/x/crypto/curve25519 | BSD-3-Clause
vendor/golang.org/x/crypto/hkdf | BSD-3-Clause
vendor/golang.org/x/net/http/httpguts | BSD-3-Clause
vendor/golang.org/x/net/idna | BSD-3-Clause
vendor/golang.org/x/text/secure/bidirule | BSD-3-Clause
vendor/golang.org/x/text/transform | BSD-3-Clause
vendor/golang.org/x/text/unicode/bidi | BSD-3-Clause
vendor/golang.org/x/text/unicode/norm | BSD-3-Clause
vendor/golang.org/x/net/http/httpproxy | BSD-3-Clause
vendor/golang.org/x/net/http2/hpack | BSD-3-Clause
gopkg.in/yaml.v3 | Unknown
ERROR failed to identify the licenses of following packages:
gopkg.in/yaml.v3
Configurations
header: # <1>
license:
spdx-id: Apache-2.0 # <2>
copyright-owner: Apache Software Foundation # <3>
content: | # <4>
Licensed to Apache Software Foundation (ASF) under one or more contributor
license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright
ownership. Apache Software Foundation (ASF) licenses this file to you 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.
pattern: | # <5>
Licensed to the Apache Software Foundation under one or more contributor
license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright
ownership. The Apache Software Foundation licenses this file to you 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.
paths: # <6>
- '**'
paths-ignore: # <7>
- 'dist'
- 'licenses'
- '**/*.md'
- '**/testdata/**'
- '**/go.mod'
- '**/go.sum'
- 'LICENSE'
- 'NOTICE'
- '**/assets/languages.yaml'
- '**/assets/assets.gen.go'
comment: on-failure # <8>
dependency: # <9>
files: # <10>
- go.mod
- The
headersection is configurations for source codes license header. - The SPDX ID of the license, it’s convenient when your license is standard SPDX license, so that you can simply specify this identifier without copying the whole license
contentorpattern. This will be used as the content whenfixcommand needs to insert a license header. - The copyright owner to replace the
[owner]in theSPDX-IDlicense template. - If you are not using the standard license text, you can paste your license text here, this will be used as the content when
fixcommand needs to insert a license header, if bothlicenseandSPDX-IDare specified,licensewins. - The
patternis an optional regexp. You don’t need this if all the file headers are the same aslicenseor the license ofSPDX-ID, otherwise you need to compose a pattern that matches your license texts. - The
pathsare the path list that will be checked (and fixed) by license-eye, default is['**']. Formats like**/*.md and**/bin/**are supported. - The
paths-ignoreare the path list that will be ignored by license-eye. By default,.gitand the content in.gitignorewill be inflated into thepaths-ignorelist. - On what condition License-Eye will comment the check results on the pull request,
on-failure,alwaysornever. Options other thanneverrequire the environment variableGITHUB_TOKENto be set. dependencysection is configurations for resolving dependencies' licenses.filesare the files that declare the dependencies of a project, typically,go.moin Go project,pom.xmlin maven project, andpackage.jsonin NodeJS project. If it's a relative path, it's relative to the.licenserc.yaml.
NOTE: When the SPDX-ID is Apache-2.0 and the owner is Apache Software foundation, the content would be a dedicated license specified by the ASF, otherwise, the license would be the standard one.
Supported File Types
The header check command theoretically supports all kinds of file types, while the supported file types of header fix command can be found in this YAML file. In the YAML file, if the language has a non-empty property comment_style_id, and the comment style id is declared in the comment styles file, then the language is supported by fix command.
-
Java: type: programming tm_scope: source.java ace_mode: java codemirror_mode: clike codemirror_mime_type: text/x-java color: "#b07219" extensions: - ".java" language_id: 181 comment_style_id: SlashAsterisk
-
- id: SlashAsterisk # (i) start: '/*' # (ii) middle: ' *' # (iii) end: ' */' # (iv)
- The
comment_style_idused in assets/languages.yaml. - The leading characters of the starting of a block comment.
- The leading characters of the middle lines of a block comment.
- The leading characters of the ending line of a block comment.
- The
Contribution
- If you find any file type should be supported by the aforementioned configurations, but it's not listed there, feel free to open a pull request to add the configuration into the two files.
- If you find the license template of an SPDX ID is not supported, feel free to open a pull request to add it into the template folder.
License
Contact Us
- Submit an issue by using [INFRA] as title prefix.
- Mail list: [email protected]. Mail to [email protected], follow the reply to subscribe the mail list.
- Join
skywalkingchannel at Apache Slack. If the link is not working, find the latest one at Apache INFRA WIKI. - Twitter, ASFSkyWalking
![[Docs] Add a PlantUML activity diagram of header fixing mechanism](https://avatars.githubusercontent.com/u/28929349?v=4)
![[config]Support config license header comment style.](https://avatars.githubusercontent.com/u/5917359?v=4)
54 Dec 17, 2022
165 Dec 5, 2022
65 Dec 22, 2022
41 Dec 5, 2021
2.6k Dec 30, 2022
10 Sep 7, 2022
3 Aug 23, 2021
0 Dec 11, 2021
29 Sep 10, 2022
128 May 22, 2021
41 Dec 7, 2022
36 Nov 26, 2022
3 May 12, 2022
0 Nov 22, 2021
4 Sep 24, 2022
50 May 14, 2022
701 Dec 30, 2022
219 Dec 29, 2021