A full-featured license tool to check and fix license headers and resolve dependencies' licenses.
You can use License-Eye in GitHub Actions or in your local machine.
To use License-Eye in GitHub Actions, add a step in your GitHub workflow.
- name: Check License Header
uses: apache/skywalking-eyes@main # always prefer to use a revision instead of `main`.
# with:
# log: debug # optional: set the log level. The default value is `info`.
# config: .licenserc.yaml # optional: set the config file. The default value is `.licenserc.yaml`.
# token: # optional: the token that license eye uses when it needs to comment on the pull request. Set to empty ("") to disable commenting on pull request. The default value is ${{ github.token }}
# mode: # optional: Which mode License-Eye should be run in. Choices are `check` or `fix`. The default value is `check`.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-failureNOTE: The full configurations can be found in the configuration section.
By default the action runs License-Eye in check mode, which will raise an error
if any of the processed files are missing license headers. If mode is set to
fix, the action will instead apply the license header to any processed file
that is missing a license header. The fixed files can then be pushed back to the
pull request using another GitHub action. For example:
- name: Check License Header
uses: apache/skywalking-eyes@main
with:
mode: fix
- name: Apply Changes
uses: EndBug/add-and-commit@v4
with:
author_name: License Bot
author_email: license_bot@github.com
message: 'Automatic application of license header'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}Note: The exit code of fix mode is always 0 and can not be used to block CI status. Consider running the action in check mode if you would like CI to fail when a file is missing a license header.
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 fixFor users and developers who want to help to test the latest codes on main branch, we publish Docker image to GitHub
Container Registry for every commit in main branch, tagged with the commit sha, if it's the latest commit in main
branch, it's also tagged with latest.
Note: these Docker images are not official Apache releases. For official releases, please refer to the download page for executable binary and the Docker hub for Docker images.
docker run -it --rm -v $(pwd):/github/workspace ghcr.io/apache/skywalking-eyes/license-eye header check
docker run -it --rm -v $(pwd):/github/workspace ghcr.io/apache/skywalking-eyes/license-eye header fixgit clone https://github.com/apache/skywalking-eyes
cd skywalking-eyes
make buildIf you have Go SDK installed, you can also use go install command to install the latest code.
go install github.com/apache/skywalking-eyes/cmd/license-eye@latestlicense-eye -c test/testdata/.licenserc_for_test_check.yaml header checkHeader Check Result
INFO Loading configuration from file: test/testdata/.licenserc_for_test_check.yaml
INFO Totally checked 30 files, valid: 12, invalid: 12, ignored: 6, 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.ini
test/testdata/include_test/without_license/testcase.java
test/testdata/include_test/without_license/testcase.md
test/testdata/include_test/without_license/testcase.php
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
test/testdata/test-spdx-asf.yaml
test/testdata/test-spdx.yaml
exit status 1
bin/darwin/license-eye -c test/testdata/.licenserc_for_test_fix.yaml header fixHeader Fix Result
INFO Loading configuration from file: test/testdata/.licenserc_for_test_fix.yaml
INFO Totally checked 20 files, valid: 10, invalid: 10, ignored: 0, fixed: 10
This command serves as assistance for human beings to audit the dependencies license, it's exit code is always 0.
You can also use the --output or -o to save the dependencies' LICENSE files to a specified directory so that
you can put them in distribution package if needed.
license-eye -c test/testdata/.licenserc_for_test_check.yaml dep resolve -o ./dependencies/licensesDependency Resolve Result
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 <github.com/gogo/protobuf>: cannot identify license content
WARNING Failed to resolve the license of <github.com/kr/logfmt>: cannot find license file
WARNING Failed to resolve the license of <github.com/magiconair/properties>: cannot identify license content
WARNING Failed to resolve the license of <github.com/miekg/dns>: cannot identify license content
WARNING Failed to resolve the license of <github.com/pascaldekloe/goe>: cannot identify license content
WARNING Failed to resolve the license of <github.com/russross/blackfriday/v2>: cannot identify license content
WARNING Failed to resolve the license of <gopkg.in/check.v1>: cannot identify license content
Dependency | License | Version
-------------------------------------------------- | -------------- | ------------------------------------
cloud.google.com/go | Apache-2.0 | v0.46.3
cloud.google.com/go/bigquery | Apache-2.0 | v1.0.1
cloud.google.com/go/datastore | Apache-2.0 | v1.0.0
cloud.google.com/go/firestore | Apache-2.0 | v1.1.0
cloud.google.com/go/pubsub | Apache-2.0 | v1.0.1
cloud.google.com/go/storage | Apache-2.0 | v1.0.0
dmitri.shuralyov.com/gpu/mtl | BSD-3-Clause | v0.0.0-20190408044501-666a987793e9
github.com/BurntSushi/toml | MIT | v0.3.1
github.com/BurntSushi/xgb | BSD-3-Clause | v0.0.0-20160522181843-27f122750802
github.com/OneOfOne/xxhash | Apache-2.0 | v1.2.2
github.com/alecthomas/template | BSD-3-Clause | v0.0.0-20160405071501-a0175ee3bccc
github.com/alecthomas/units | MIT | v0.0.0-20151022065526-2efee857e7cf
github.com/armon/circbuf | MIT | v0.0.0-20150827004946-bbbad097214e
github.com/armon/go-metrics | MIT | v0.0.0-20180917152333-f0300d1749da
github.com/armon/go-radix | MIT | v0.0.0-20180808171621-7fddfc383310
github.com/beorn7/perks | MIT | v1.0.0
github.com/bgentry/speakeasy | MIT | v0.1.0
github.com/bketelsen/crypt | MIT | v0.0.3-0.20200106085610-5cbc8cc4026c
github.com/bmatcuk/doublestar/v2 | MIT | v2.0.4
github.com/cespare/xxhash | MIT | v1.1.0
github.com/client9/misspell | MIT | v0.3.4
github.com/coreos/bbolt | MIT | v1.3.2
github.com/coreos/etcd | Apache-2.0 | v3.3.13+incompatible
github.com/coreos/go-semver | Apache-2.0 | v0.3.0
github.com/coreos/go-systemd | Apache-2.0 | v0.0.0-20190321100706-95778dfbb74e
github.com/coreos/pkg | Apache-2.0 | v0.0.0-20180928190104-399ea9e2e55f
github.com/cpuguy83/go-md2man/v2 | MIT | v2.0.0
github.com/davecgh/go-spew | ISC | v1.1.1
github.com/dgrijalva/jwt-go | MIT | v3.2.0+incompatible
github.com/dgryski/go-sip13 | MIT | v0.0.0-20181026042036-e10d5fee7954
github.com/fatih/color | MIT | v1.7.0
github.com/fsnotify/fsnotify | BSD-3-Clause | v1.4.7
github.com/ghodss/yaml | MIT | v1.0.0
github.com/go-gl/glfw | BSD-3-Clause | v0.0.0-20190409004039-e6da0acd62b1
github.com/go-kit/kit | MIT | v0.8.0
github.com/go-logfmt/logfmt | MIT | v0.4.0
github.com/go-stack/stack | MIT | v1.8.0
github.com/golang/glog | Apache-2.0 | v0.0.0-20160126235308-23def4e6c14b
github.com/golang/groupcache | Apache-2.0 | v0.0.0-20190129154638-5b532d6fd5ef
github.com/golang/mock | Apache-2.0 | v1.3.1
github.com/golang/protobuf | BSD-3-Clause | v1.3.2
github.com/google/btree | Apache-2.0 | v1.0.0
github.com/google/go-cmp | BSD-3-Clause | v0.3.0
github.com/google/go-github/v33 | BSD-3-Clause | v33.0.0
github.com/google/go-querystring | BSD-3-Clause | v1.0.0
github.com/google/martian | Apache-2.0 | v2.1.0+incompatible
github.com/google/pprof | Apache-2.0 | v0.0.0-20190515194954-54271f7e092f
github.com/google/renameio | Apache-2.0 | v0.1.0
github.com/googleapis/gax-go/v2 | BSD-3-Clause | v2.0.5
github.com/gopherjs/gopherjs | BSD-2-Clause | v0.0.0-20181017120253-0766667cb4d1
github.com/gorilla/websocket | BSD-2-Clause | v1.4.2
github.com/grpc-ecosystem/go-grpc-middleware | Apache-2.0 | v1.0.0
github.com/grpc-ecosystem/go-grpc-prometheus | Apache-2.0 | v1.2.0
github.com/grpc-ecosystem/grpc-gateway | BSD-3-Clause | v1.9.0
github.com/hashicorp/consul/api | MPL-2.0 | v1.1.0
github.com/hashicorp/consul/sdk | MPL-2.0 | v0.1.1
github.com/hashicorp/errwrap | MPL-2.0 | v1.0.0
github.com/hashicorp/go-cleanhttp | MPL-2.0 | v0.5.1
github.com/hashicorp/go-immutable-radix | MPL-2.0 | v1.0.0
github.com/hashicorp/go-msgpack | BSD-3-Clause | v0.5.3
github.com/hashicorp/go-multierror | MPL-2.0 | v1.0.0
github.com/hashicorp/go-rootcerts | MPL-2.0 | v1.0.0
github.com/hashicorp/go-sockaddr | MPL-2.0 | v1.0.0
github.com/hashicorp/go-syslog | MIT | v1.0.0
github.com/hashicorp/go-uuid | MPL-2.0 | v1.0.1
github.com/hashicorp/go.net | BSD-3-Clause | v0.0.1
github.com/hashicorp/golang-lru | MPL-2.0 | v0.5.1
github.com/hashicorp/hcl | MPL-2.0 | v1.0.0
github.com/hashicorp/logutils | MPL-2.0 | v1.0.0
github.com/hashicorp/mdns | MIT | v1.0.0
github.com/hashicorp/memberlist | MPL-2.0 | v0.1.3
github.com/hashicorp/serf | MPL-2.0 | v0.8.2
github.com/inconshreveable/mousetrap | Apache-2.0 | v1.0.0
github.com/jonboulle/clockwork | Apache-2.0 | v0.1.0
github.com/json-iterator/go | MIT | v1.1.6
github.com/jstemmer/go-junit-report | MIT | v0.0.0-20190106144839-af01ea7f8024
github.com/jtolds/gls | MIT | v4.20.0+incompatible
github.com/julienschmidt/httprouter | BSD-3-Clause | v1.2.0
github.com/kisielk/errcheck | MIT | v1.1.0
github.com/kisielk/gotool | MIT | v1.0.0
github.com/konsorten/go-windows-terminal-sequences | MIT | v1.0.1
github.com/kr/pretty | MIT | v0.1.0
github.com/kr/pty | MIT | v1.1.1
github.com/kr/text | MIT | v0.1.0
github.com/mattn/go-colorable | MIT | v0.0.9
github.com/mattn/go-isatty | MIT | v0.0.3
github.com/matttproud/golang_protobuf_extensions | Apache-2.0 | v1.0.1
github.com/mitchellh/cli | MPL-2.0 | v1.0.0
github.com/mitchellh/go-homedir | MIT | v1.1.0
github.com/mitchellh/go-testing-interface | MIT | v1.0.0
github.com/mitchellh/gox | MPL-2.0 | v0.4.0
github.com/mitchellh/iochan | MIT | v1.0.0
github.com/mitchellh/mapstructure | MIT | v1.1.2
github.com/modern-go/concurrent | Apache-2.0 | v0.0.0-20180306012644-bacd9c7ef1dd
github.com/modern-go/reflect2 | Apache-2.0 | v1.0.1
github.com/mwitkow/go-conntrack | Apache-2.0 | v0.0.0-20161129095857-cc309e4a2223
github.com/oklog/ulid | Apache-2.0 | v1.3.1
github.com/pelletier/go-toml | MIT | v1.2.0
github.com/pkg/errors | BSD-2-Clause | v0.8.1
github.com/pmezard/go-difflib | BSD-3-Clause | v1.0.0
github.com/posener/complete | MIT | v1.1.1
github.com/prometheus/client_golang | Apache-2.0 | v0.9.3
github.com/prometheus/client_model | Apache-2.0 | v0.0.0-20190129233127-fd36f4220a90
github.com/prometheus/common | Apache-2.0 | v0.4.0
github.com/prometheus/procfs | Apache-2.0 | v0.0.0-20190507164030-5867b95ac084
github.com/prometheus/tsdb | Apache-2.0 | v0.7.1
github.com/rogpeppe/fastuuid | BSD-3-Clause | v0.0.0-20150106093220-6724a57986af
github.com/rogpeppe/go-internal | BSD-3-Clause | v1.3.0
github.com/ryanuber/columnize | MIT | v0.0.0-20160712163229-9b3edd62028f
github.com/sean-/seed | MIT | v0.0.0-20170313163322-e2103e2c3529
github.com/shurcooL/sanitized_anchor_name | MIT | v1.0.0
github.com/sirupsen/logrus | MIT | v1.7.0
github.com/smartystreets/assertions | MIT | v0.0.0-20180927180507-b2de0cb4f26d
github.com/smartystreets/goconvey | MIT | v1.6.4
github.com/soheilhy/cmux | Apache-2.0 | v0.1.4
github.com/spaolacci/murmur3 | BSD-3-Clause | v0.0.0-20180118202830-f09979ecbc72
github.com/spf13/afero | Apache-2.0 | v1.1.2
github.com/spf13/cast | MIT | v1.3.0
github.com/spf13/cobra | Apache-2.0 | v1.1.1
github.com/spf13/jwalterweatherman | MIT | v1.0.0
github.com/spf13/pflag | BSD-3-Clause | v1.0.5
github.com/spf13/viper | MIT | v1.7.0
github.com/stretchr/objx | MIT | v0.1.1
github.com/stretchr/testify | MIT | v1.3.0
github.com/subosito/gotenv | MIT | v1.2.0
github.com/tmc/grpc-websocket-proxy | MIT | v0.0.0-20190109142713-0ad062ec5ee5
github.com/xiang90/probing | MIT | v0.0.0-20190116061207-43a291ad63a2
github.com/yuin/goldmark | MIT | v1.3.5
go.etcd.io/bbolt | MIT | v1.3.2
go.opencensus.io | Apache-2.0 | v0.22.0
go.uber.org/atomic | MIT | v1.4.0
go.uber.org/multierr | MIT | v1.1.0
go.uber.org/zap | MIT | v1.10.0
golang.org/x/crypto | BSD-3-Clause | v0.0.0-20191011191535-87dc89f01550
golang.org/x/exp | BSD-3-Clause | v0.0.0-20191030013958-a1ab85dbe136
golang.org/x/image | BSD-3-Clause | v0.0.0-20190802002840-cff245a6509b
golang.org/x/lint | BSD-3-Clause | v0.0.0-20190930215403-16217165b5de
golang.org/x/mobile | BSD-3-Clause | v0.0.0-20190719004257-d2bd2a29d028
golang.org/x/mod | BSD-3-Clause | v0.4.2
golang.org/x/net | BSD-3-Clause | v0.0.0-20210726213435-c6fcb2dbf985
golang.org/x/oauth2 | BSD-3-Clause | v0.0.0-20190604053449-0f29369cfe45
golang.org/x/sync | BSD-3-Clause | v0.0.0-20210220032951-036812b2e83c
golang.org/x/sys | BSD-3-Clause | v0.0.0-20210510120138-977fb7262007
golang.org/x/term | BSD-3-Clause | v0.0.0-20201126162022-7de9c90e9dd1
golang.org/x/text | BSD-3-Clause | v0.3.6
golang.org/x/time | BSD-3-Clause | v0.0.0-20190308202827-9d24e82272b4
golang.org/x/tools | BSD-3-Clause | v0.1.5
golang.org/x/xerrors | BSD-3-Clause | v0.0.0-20200804184101-5ec99f83aff1
google.golang.org/api | BSD-3-Clause | v0.13.0
google.golang.org/appengine | Apache-2.0 | v1.6.1
google.golang.org/genproto | Apache-2.0 | v0.0.0-20191108220845-16a3f7862a1a
google.golang.org/grpc | Apache-2.0 | v1.21.1
gopkg.in/alecthomas/kingpin.v2 | MIT | v2.2.6
gopkg.in/errgo.v2 | BSD-3-Clause | v2.1.0
gopkg.in/ini.v1 | Apache-2.0 | v1.51.0
gopkg.in/resty.v1 | MIT | v1.12.0
gopkg.in/yaml.v2 | Apache-2.0 | v2.2.8
gopkg.in/yaml.v3 | MIT and Apache | v3.0.0-20200615113413-eeeca48fe776
honnef.co/go/tools | MIT | v0.0.1-2019.2.3
rsc.io/binaryregexp | BSD-3-Clause | v0.2.0
github.com/gogo/protobuf | Unknown | v1.2.1
github.com/kr/logfmt | Unknown | v0.0.0-20140226030751-b84e30acd515
github.com/magiconair/properties | Unknown | v1.8.1
github.com/miekg/dns | Unknown | v1.0.14
github.com/pascaldekloe/goe | Unknown | v0.0.0-20180627143212-57f6aae5913c
github.com/russross/blackfriday/v2 | Unknown | v2.0.1
gopkg.in/check.v1 | Unknown | v1.0.0-20180628173108-788fd7840127
ERROR failed to identify the licenses of following packages (7):
github.com/gogo/protobuf
github.com/kr/logfmt
github.com/magiconair/properties
github.com/miekg/dns
github.com/pascaldekloe/goe
github.com/russross/blackfriday/v2
gopkg.in/check.v1
This command can be used to perform automatic license compatibility check, when there is incompatible licenses found, the command will exit with status code 1 and fail the command.
license-eye -c test/testdata/.licenserc_for_test_check.yaml dep checkDependency Check Result
INFO GITHUB_TOKEN is not set, license-eye won't comment on the pull request
INFO Loading configuration from file: .licenserc.yaml
WARNING Failed to resolve the license of <github.com/gogo/protobuf>: cannot identify license content
WARNING Failed to resolve the license of <github.com/kr/logfmt>: cannot find license file
WARNING Failed to resolve the license of <github.com/magiconair/properties>: cannot identify license content
WARNING Failed to resolve the license of <github.com/miekg/dns>: cannot identify license content
WARNING Failed to resolve the license of <github.com/pascaldekloe/goe>: cannot identify license content
WARNING Failed to resolve the license of <github.com/russross/blackfriday/v2>: cannot identify license content
WARNING Failed to resolve the license of <gopkg.in/check.v1>: cannot identify license content
ERROR the following licenses are incompatible with the main license: Apache-2.0
License: Unknown Dependency: github.com/gogo/protobuf
License: Unknown Dependency: github.com/kr/logfmt
License: Unknown Dependency: github.com/magiconair/properties
License: Unknown Dependency: github.com/miekg/dns
License: Unknown Dependency: github.com/pascaldekloe/goe
License: Unknown Dependency: github.com/russross/blackfriday/v2
License: Unknown Dependency: gopkg.in/check.v1
exit status 1
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.modin 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.
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
- There is an activity diagram explaining the implemented license header fixing mechanism in-depth. The diagram's source file can be found here.
- 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.
- Submit an issue by using [INFRA] as title prefix.
- Mail list: dev@skywalking.apache.org. Mail to dev-subscribe@skywalking.apache.org, 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