This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-eyes.git
The following commit(s) were added to refs/heads/main by this push:
new 27c147b Move license-eye to root of repo (#15)
27c147b is described below
commit 27c147b8194042e56d59c740a5125444c56f17ad
Author: Zhenxu Ke <[email protected]>
AuthorDate: Sun Dec 27 17:38:55 2020 +0800
Move license-eye to root of repo (#15)
---
.github/workflows/license-eye-check.yaml | 4 -
.gitignore | 2 +-
.licenserc.yaml | 2 +-
license-eye/CHANGES.md => CHANGES.md | 0
license-eye/Dockerfile => Dockerfile | 0
LICENSE | 9 +
license-eye/Makefile => Makefile | 2 +-
README.md | 249 +++++++++++++++++++-
.../header-templates/Apache-2.0-ASF.txt | 0
.../header-templates/Apache-2.0.txt | 0
{license-eye/assets => assets}/languages.yaml | 0
.../assets => assets}/lcs-templates/Apache-2.0.txt | 0
.../lcs-templates/BSD-3-Clause.txt | 0
.../assets => assets}/lcs-templates/MIT.txt | 0
{license-eye/assets => assets}/styles.yaml | 0
{license-eye/cmd => cmd}/license-eye/main.go | 0
{license-eye/commands => commands}/deps.go | 0
{license-eye/commands => commands}/deps_resolve.go | 0
{license-eye/commands => commands}/header.go | 0
{license-eye/commands => commands}/header_check.go | 0
{license-eye/commands => commands}/header_fix.go | 0
{license-eye/commands => commands}/root.go | 0
{license-eye/commands => commands}/version.go | 0
{license-eye/dist => dist}/LICENSE | 0
{license-eye/dist => dist}/NOTICE | 0
.../dist => dist}/licenses/LICENSE-doublestar.txt | 0
.../dist => dist}/licenses/LICENSE-go-github.txt | 0
.../licenses/LICENSE-golang-oauth2.txt | 0
.../dist => dist}/licenses/LICENSE-linguist.txt | 0
.../dist => dist}/licenses/LICENSE-logrus.txt | 0
.../dist => dist}/licenses/LICENSE-yaml.v3.txt | 0
license-eye/go.mod => go.mod | 0
license-eye/go.sum => go.sum | 1 +
{license-eye/internal => internal}/logger/log.go | 0
license-eye/LICENSE | 219 ------------------
license-eye/README.adoc | 251 ---------------------
.../licenses => licenses}/LICENSE-linguist | 0
{license-eye/pkg => pkg}/comments/config.go | 0
{license-eye/pkg => pkg}/comments/config_test.go | 0
{license-eye/pkg => pkg}/config/config.go | 0
{license-eye/pkg => pkg}/deps/config.go | 0
{license-eye/pkg => pkg}/deps/golang.go | 0
{license-eye/pkg => pkg}/deps/resolve.go | 0
{license-eye/pkg => pkg}/deps/result.go | 0
{license-eye/pkg => pkg}/header/check.go | 0
{license-eye/pkg => pkg}/header/check_test.go | 0
{license-eye/pkg => pkg}/header/config.go | 0
{license-eye/pkg => pkg}/header/fix.go | 0
{license-eye/pkg => pkg}/header/fix_test.go | 0
{license-eye/pkg => pkg}/header/result.go | 0
{license-eye/pkg => pkg}/license/identifier.go | 0
{license-eye/pkg => pkg}/license/norm.go | 0
{license-eye/pkg => pkg}/license/norm_test.go | 0
{license-eye/pkg => pkg}/review/header.go | 0
quality-eye/README.md | 5 -
{license-eye/test => test}/config_test.go | 0
.../testdata/.licenserc_for_test_check.yaml | 0
.../testdata/.licenserc_for_test_fix.yaml | 0
.../testdata/exclude_test/directories/testcase.go | 0
.../testdata/exclude_test/extensions/testcase.json | 0
.../testdata/exclude_test/extensions/testcase.md | 0
.../testdata/exclude_test/extensions/testcase.xml | 0
.../testdata/include_test/with_license/testcase.go | 0
.../include_test/with_license/testcase.graphql | 0
.../include_test/with_license/testcase.java | 0
.../testdata/include_test/with_license/testcase.ml | 0
.../testdata/include_test/with_license/testcase.py | 0
.../testdata/include_test/with_license/testcase.sh | 0
.../include_test/with_license/testcase.yaml | 0
.../include_test/with_license/testcase.yml | 0
.../include_test/without_license/testcase.go | 0
.../include_test/without_license/testcase.graphql | 0
.../include_test/without_license/testcase.java | 0
.../include_test/without_license/testcase.md | 0
.../include_test/without_license/testcase.py | 0
.../include_test/without_license/testcase.sh | 0
.../include_test/without_license/testcase.yaml | 0
.../include_test/without_license/testcase.yml | 0
.../test => test}/testdata/test-spdx-asf.yaml | 0
{license-eye/test => test}/testdata/test-spdx.yaml | 0
80 files changed, 250 insertions(+), 494 deletions(-)
diff --git a/.github/workflows/license-eye-check.yaml
b/.github/workflows/license-eye-check.yaml
index 869db6d..065a8fa 100644
--- a/.github/workflows/license-eye-check.yaml
+++ b/.github/workflows/license-eye-check.yaml
@@ -24,10 +24,6 @@ on:
branches:
- main
-defaults:
- run:
- working-directory: license-eye
-
jobs:
build-license-eye:
name: Build LicenseEye
diff --git a/.gitignore b/.gitignore
index a90f1dd..faaafa1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -17,6 +17,6 @@
#
.idea/
bin/
-license-eye/assets/assets.gen.go
+assets/assets.gen.go
.DS_Store
coverage.txt
diff --git a/.licenserc.yaml b/.licenserc.yaml
index db09875..fbf15b1 100644
--- a/.licenserc.yaml
+++ b/.licenserc.yaml
@@ -78,4 +78,4 @@ header: # `header` section is configurations for source codes
license header.
dependency:
files:
- - license-eye/go.mod
+ - go.mod
diff --git a/license-eye/CHANGES.md b/CHANGES.md
similarity index 100%
rename from license-eye/CHANGES.md
rename to CHANGES.md
diff --git a/license-eye/Dockerfile b/Dockerfile
similarity index 100%
rename from license-eye/Dockerfile
rename to Dockerfile
diff --git a/LICENSE b/LICENSE
index 67c185f..e4b71ce 100644
--- a/LICENSE
+++ b/LICENSE
@@ -208,3 +208,12 @@ The Apache SkyWalking Eyes project contains subcomponents
with separate copyrigh
notices and license terms. Your use of the source code for the these
subcomponents is subject to the terms and conditions of the following
licenses.
+
+========================================================================
+MIT licenses
+========================================================================
+
+The following components are provided under the MIT license. See project link
for details.
+The text of each license is also included at licenses/LICENSE-[project].txt.
+
+ languages.yaml from GitHub:
https://github.com/github/linguist/blob/master/lib/linguist/languages.yml MIT
diff --git a/license-eye/Makefile b/Makefile
similarity index 98%
rename from license-eye/Makefile
rename to Makefile
index 41e914b..c2df156 100644
--- a/license-eye/Makefile
+++ b/Makefile
@@ -51,7 +51,7 @@ fix-lint:
.PHONY: license
license: clean codegen
- $(GO) run cmd/$(PROJECT)/main.go header check -c ../.licenserc.yaml
+ $(GO) run cmd/$(PROJECT)/main.go header check
.PHONY: codegen
codegen: clean
diff --git a/README.md b/README.md
index 8f94610..c0b34bc 100644
--- a/README.md
+++ b/README.md
@@ -2,24 +2,249 @@
<img src="http://skywalking.apache.org/assets/logo.svg"; alt="Sky Walking logo"
height="90px" align="right" />
-Infra tools that are created and used by the SkyWalking Team.
+A full-featured license tool to check and fix license headers and resolve
dependencies' licenses.
[](https://twitter.com/AsfSkyWalking)
-## Contact Us
-* Submit [an issue](https://github.com/apache/skywalking/issues/new) by using
[INFRA] as title prefix.
-* Mail list: **[email protected]**. Mail to
`[email protected]`, follow the reply to subscribe the mail
list.
-* Join `skywalking` channel at [Apache
Slack](http://s.apache.org/slack-invite). If the link is not working, find the
latest one at [Apache INFRA
WIKI](https://cwiki.apache.org/confluence/display/INFRA/Slack+Guest+Invites).
-* Twitter, [ASFSkyWalking](https://twitter.com/ASFSkyWalking)
+## 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.
+
+```yaml
+- name: Check License Header
+ uses: apache/skywalking-eyes@main # 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.
+
+```yaml
+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](#configurations).
+
+### Use as a Binary
+
+#### Install
+
+```bash
+$ git clone https://github.com/apache/skywalking-eyes
+$ cd skywalking-eyes/license-eye
+$ make build
+```
+
+#### Check License Header
+
+```bash
+$ 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
+
+```bash
+$ 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
+
+```bash
+$ 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
+```
-## License Eye
-A full-featured license guard to check and fix license headers and
dependencies' licenses.
+## Configurations
-Read [the doc](license-eye/README.adoc) on how to use license-eye.
+```yaml
+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
-## Quality Eye
+ http://www.apache.org/licenses/LICENSE-2.0
-The next generation of end-to-end test framework that eyes on software quality.
+ 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.
-Read [the doc](quality-eye/README.md) on how the quality-eye is designed.
+ 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
+```
+
+1. The `header` section is configurations for source codes license header.
+2. The [SPDX ID](https://spdx.org/licenses/) 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 `content` or `pattern`. This will
be used as the content when `fix` command needs to insert a license header.
+3. The copyright owner to replace the `[owner]` in the `SPDX-ID` license
template.
+4. If you are not using the standard license text, you can paste your license
text here, this will be used as the content when `fix` command needs to insert
a license header, if both `license` and `SPDX-ID` are specified, `license` wins.
+5. The `pattern` is an optional regexp. You don’t need this if all the file
headers are the same as `license` or the license of `SPDX-ID`, otherwise you
need to compose a pattern that matches your license texts.
+6. The `paths` are the path list that will be checked (and fixed) by
license-eye, default is `['**']`. Formats like `**/*`.md and `**/bin/**` are
supported.
+7. The `paths-ignore` are the path list that will be ignored by license-eye.
By default, `.git` and the content in `.gitignore` will be inflated into the
`paths-ignore` list.
+8. On what condition License-Eye will comment the check results on the pull
request, `on-failure`, `always` or `never`. Options other than `never` require
the environment variable `GITHUB_TOKEN` to be set.
+9. `dependency` section is configurations for resolving dependencies' licenses.
+10. `files` are the files that declare the dependencies of a project,
typically, `go.mo` in Go project, `pom.xml` in maven project, and
`package.json` in 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](https://www.apache.org/legal/src-headers.html#headers) specified by
the ASF, otherwise, the license would be [the standard
one](https://www.apache.org/foundation/license-faq.html#Apply-My-Software).
+
+## 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](assets/languages.yaml). 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](assets/styles.yaml), then the language is supported
by `fix` command.
+
+- [assets/languages.yaml](assets/languages.yaml)
+
+ ```yaml
+ 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
+ ```
+
+- [assets/languages.yaml](assets/languages.yaml)
+
+ ```yaml
+ - id: SlashAsterisk # (i)
+ start: '/*' # (ii)
+ middle: ' *' # (iii)
+ end: ' */' # (iv)
+ ```
+
+ 1. The `comment_style_id` used in
[assets/languages.yaml](assets/languages.yaml).
+ 2. The leading characters of the starting of a block comment.
+ 3. The leading characters of the middle lines of a block comment.
+ 4. The leading characters of the ending line of a block comment.
+
+## 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](https://github.com/apache/skywalking-eyes/pulls) 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](https://github.com/apache/skywalking-eyes/pulls) to
add it into [the template folder](assets/header-templates).
+
+## License
+
+[Apache License
2.0](https://github.com/apache/skywalking-eyes/blob/master/LICENSE)
+
+## Contact Us
+* Submit [an issue](https://github.com/apache/skywalking/issues/new) by using
[INFRA] as title prefix.
+* Mail list: **[email protected]**. Mail to
[email protected], follow the reply to subscribe the mail
list.
+* Join `skywalking` channel at [Apache
Slack](http://s.apache.org/slack-invite). If the link is not working, find the
latest one at [Apache INFRA
WIKI](https://cwiki.apache.org/confluence/display/INFRA/Slack+Guest+Invites).
+* Twitter, [ASFSkyWalking](https://twitter.com/ASFSkyWalking)
diff --git a/license-eye/assets/header-templates/Apache-2.0-ASF.txt
b/assets/header-templates/Apache-2.0-ASF.txt
similarity index 100%
rename from license-eye/assets/header-templates/Apache-2.0-ASF.txt
rename to assets/header-templates/Apache-2.0-ASF.txt
diff --git a/license-eye/assets/header-templates/Apache-2.0.txt
b/assets/header-templates/Apache-2.0.txt
similarity index 100%
rename from license-eye/assets/header-templates/Apache-2.0.txt
rename to assets/header-templates/Apache-2.0.txt
diff --git a/license-eye/assets/languages.yaml b/assets/languages.yaml
similarity index 100%
rename from license-eye/assets/languages.yaml
rename to assets/languages.yaml
diff --git a/license-eye/assets/lcs-templates/Apache-2.0.txt
b/assets/lcs-templates/Apache-2.0.txt
similarity index 100%
rename from license-eye/assets/lcs-templates/Apache-2.0.txt
rename to assets/lcs-templates/Apache-2.0.txt
diff --git a/license-eye/assets/lcs-templates/BSD-3-Clause.txt
b/assets/lcs-templates/BSD-3-Clause.txt
similarity index 100%
rename from license-eye/assets/lcs-templates/BSD-3-Clause.txt
rename to assets/lcs-templates/BSD-3-Clause.txt
diff --git a/license-eye/assets/lcs-templates/MIT.txt
b/assets/lcs-templates/MIT.txt
similarity index 100%
rename from license-eye/assets/lcs-templates/MIT.txt
rename to assets/lcs-templates/MIT.txt
diff --git a/license-eye/assets/styles.yaml b/assets/styles.yaml
similarity index 100%
rename from license-eye/assets/styles.yaml
rename to assets/styles.yaml
diff --git a/license-eye/cmd/license-eye/main.go b/cmd/license-eye/main.go
similarity index 100%
rename from license-eye/cmd/license-eye/main.go
rename to cmd/license-eye/main.go
diff --git a/license-eye/commands/deps.go b/commands/deps.go
similarity index 100%
rename from license-eye/commands/deps.go
rename to commands/deps.go
diff --git a/license-eye/commands/deps_resolve.go b/commands/deps_resolve.go
similarity index 100%
rename from license-eye/commands/deps_resolve.go
rename to commands/deps_resolve.go
diff --git a/license-eye/commands/header.go b/commands/header.go
similarity index 100%
rename from license-eye/commands/header.go
rename to commands/header.go
diff --git a/license-eye/commands/header_check.go b/commands/header_check.go
similarity index 100%
rename from license-eye/commands/header_check.go
rename to commands/header_check.go
diff --git a/license-eye/commands/header_fix.go b/commands/header_fix.go
similarity index 100%
rename from license-eye/commands/header_fix.go
rename to commands/header_fix.go
diff --git a/license-eye/commands/root.go b/commands/root.go
similarity index 100%
rename from license-eye/commands/root.go
rename to commands/root.go
diff --git a/license-eye/commands/version.go b/commands/version.go
similarity index 100%
rename from license-eye/commands/version.go
rename to commands/version.go
diff --git a/license-eye/dist/LICENSE b/dist/LICENSE
similarity index 100%
rename from license-eye/dist/LICENSE
rename to dist/LICENSE
diff --git a/license-eye/dist/NOTICE b/dist/NOTICE
similarity index 100%
rename from license-eye/dist/NOTICE
rename to dist/NOTICE
diff --git a/license-eye/dist/licenses/LICENSE-doublestar.txt
b/dist/licenses/LICENSE-doublestar.txt
similarity index 100%
rename from license-eye/dist/licenses/LICENSE-doublestar.txt
rename to dist/licenses/LICENSE-doublestar.txt
diff --git a/license-eye/dist/licenses/LICENSE-go-github.txt
b/dist/licenses/LICENSE-go-github.txt
similarity index 100%
rename from license-eye/dist/licenses/LICENSE-go-github.txt
rename to dist/licenses/LICENSE-go-github.txt
diff --git a/license-eye/dist/licenses/LICENSE-golang-oauth2.txt
b/dist/licenses/LICENSE-golang-oauth2.txt
similarity index 100%
rename from license-eye/dist/licenses/LICENSE-golang-oauth2.txt
rename to dist/licenses/LICENSE-golang-oauth2.txt
diff --git a/license-eye/dist/licenses/LICENSE-linguist.txt
b/dist/licenses/LICENSE-linguist.txt
similarity index 100%
rename from license-eye/dist/licenses/LICENSE-linguist.txt
rename to dist/licenses/LICENSE-linguist.txt
diff --git a/license-eye/dist/licenses/LICENSE-logrus.txt
b/dist/licenses/LICENSE-logrus.txt
similarity index 100%
rename from license-eye/dist/licenses/LICENSE-logrus.txt
rename to dist/licenses/LICENSE-logrus.txt
diff --git a/license-eye/dist/licenses/LICENSE-yaml.v3.txt
b/dist/licenses/LICENSE-yaml.v3.txt
similarity index 100%
rename from license-eye/dist/licenses/LICENSE-yaml.v3.txt
rename to dist/licenses/LICENSE-yaml.v3.txt
diff --git a/license-eye/go.mod b/go.mod
similarity index 100%
rename from license-eye/go.mod
rename to go.mod
diff --git a/license-eye/go.sum b/go.sum
similarity index 99%
rename from license-eye/go.sum
rename to go.sum
index 2da1b0f..6693a91 100644
--- a/license-eye/go.sum
+++ b/go.sum
@@ -17,6 +17,7 @@ github.com/OneOfOne/xxhash v1.2.2/go.mod
h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAE
github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod
h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod
h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0=
github.com/apache/skywalking-eyes v0.0.0-20201226021955-d798d4f56aa5
h1:cMn7kz937Lz92NBpMXbawQlizM4qe3LYMil+DWQxznE=
+github.com/apache/skywalking-eyes v0.0.0-20201227090648-038d724e60b2
h1:ZcHWJoGStYz0e8hSzRoyc9sKWvDuBWfvh5CPY2W9zic=
github.com/armon/circbuf v0.0.0-20150827004946-bbbad097214e/go.mod
h1:3U/XgcO3hCbHZ8TKRvWD2dDTCfh9M9ya+I9JpbB7O8o=
github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da/go.mod
h1:Q73ZrmVTwzkszR9V5SSuryQ31EELlFMUz1kKyl939pY=
github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310/go.mod
h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8=
diff --git a/license-eye/internal/logger/log.go b/internal/logger/log.go
similarity index 100%
rename from license-eye/internal/logger/log.go
rename to internal/logger/log.go
diff --git a/license-eye/LICENSE b/license-eye/LICENSE
deleted file mode 100644
index e4b71ce..0000000
--- a/license-eye/LICENSE
+++ /dev/null
@@ -1,219 +0,0 @@
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- 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.
-
-
-=======================================================================
-Apache SkyWalking Eyes Subcomponents:
-
-The Apache SkyWalking Eyes project contains subcomponents with separate
copyright
-notices and license terms. Your use of the source code for the these
-subcomponents is subject to the terms and conditions of the following
-licenses.
-
-========================================================================
-MIT licenses
-========================================================================
-
-The following components are provided under the MIT license. See project link
for details.
-The text of each license is also included at licenses/LICENSE-[project].txt.
-
- languages.yaml from GitHub:
https://github.com/github/linguist/blob/master/lib/linguist/languages.yml MIT
diff --git a/license-eye/README.adoc b/license-eye/README.adoc
deleted file mode 100644
index 11e2707..0000000
--- a/license-eye/README.adoc
+++ /dev/null
@@ -1,251 +0,0 @@
-//
-// 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.
-//
-= License-Eye
-:repo: https://github.com/apache/skywalking-eyes
-:name: License-Eye
-
-A full-featured license guard to check and fix license headers and
dependencies' licenses.
-
-== Usage
-
-You can use {name} in GitHub Actions or in your local machine.
-
-=== GitHub Actions
-
-To use {name} in GitHub Actions, add a step in your GitHub workflow.
-
-[source,yaml]
-----
-- name: Check License Header
- uses: apache/skywalking-eyes@main # 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.
-
-[source,yaml]
-----
-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 <<Configurations,the
configuration section>>.
-
-=== Use as a Binary
-
-==== Install
-
-[subs="attributes",source,bash]
-----
-$ git clone {repo}
-$ cd skywalking-eyes/license-eye
-$ make build
-----
-
-===== Check License Header
-
-[source,bash]
-----
-$ 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
-
-[source,bash]
-----
-$ 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
-
-[source,bash]
-----
-$ 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
-
-[source,yaml]
-----
-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
-----
-<1> `header` section is configurations for source codes license header.
-<2> The link:https://spdx.org/licenses/[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 `content` or
`pattern`. This will be used as the content when `fix` command needs to insert
a license header.
-<3> The copyright owner to replace the `[owner]` in the `SPDX-ID` license
template.
-<4> If you are not using the standard license text, you can paste your license
text here, this will be used as the content when `fix` command needs to insert
a license header, if both `license` and `SPDX-ID` are specified, `license` wins.
-<5> `pattern` is an optional regexp. You don't need this if all the file
headers are the same as `license` or the license of `SPDX-ID`, otherwise you
need to compose a pattern that matches your license texts.
-<6> `paths` are the path list that will be checked (and fixed) by license-eye,
default is `['++**++']`. Formats like `++**/*.md++` and `++**/bin/**++` are
supported.
-<7> `paths-ignore` are the path list that will be ignored by license-eye. By
default, `.git` and the content in `.gitignore` will be inflated into the
`paths-ignore` list.
-<8> On what condition {name} will comment the check results on the pull
request, `on-failure`, `always`, `never`. Options other than `never` require
the environment variable `GITHUB_TOKEN` to be set.
-<9> `dependency` section is configurations for resolving dependencies'
licenses.
-<10> `files` are the files that declare the dependencies of a project,
typically, `go.mo` in Go project, `pom.xml` in maven project, and
`package.json` in 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
link:https://www.apache.org/legal/src-headers.html#headers[a dedicated license]
link:https://www.apache.org/foundation/license-faq.html#Apply-My-Software[specified
by the ASF], otherwise, the license would be
link:https://www.apache.org/foundation/license-faq.html#Apply-My-Software[the
standard one].
-
-== Supported File Types
-
-The `check` command theoretically supports all kinds of file types, while the
supported file types of `fix` command can be found
link:assets/languages.yaml[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 link:assets/styles.yaml[the comment
styles file], then the language is supported by `fix` command.
-
-[source,yaml]
-.link:assets/languages.yaml[tags=java]
-----
-include::assets/languages.yaml[tags=java]
-----
-
-[source,yaml]
-.link:assets/styles.yaml[tags=SlashAsterisk]
-----
-include::assets/styles.yaml[tags=SlashAsterisk]
-----
-<1> The leading characters of the starting of a block comment.
-<2> The leading characters of the middle lines of a block comment.
-<3> The leading characters of the ending line of a block comment.
-
-== Contribution
-
-- If you find any file type should be supported by the aforementioned
configurations but is not listed there, feel free to
link:https://github.com/apache/skywalking-eyes/pulls[open a pull request] to
add the configuration into the 2 files.
-- If you find the license template of an SPDX ID is not supported, feel free
to link:https://github.com/apache/skywalking-eyes/pulls[open a pull request] to
add it into link:assets/header-templates[the template folder].
-
-== License
-
-link:https://github.com/apache/skywalking/blob/master/LICENSE[Apache License
2.0]
diff --git a/license-eye/licenses/LICENSE-linguist b/licenses/LICENSE-linguist
similarity index 100%
rename from license-eye/licenses/LICENSE-linguist
rename to licenses/LICENSE-linguist
diff --git a/license-eye/pkg/comments/config.go b/pkg/comments/config.go
similarity index 100%
rename from license-eye/pkg/comments/config.go
rename to pkg/comments/config.go
diff --git a/license-eye/pkg/comments/config_test.go
b/pkg/comments/config_test.go
similarity index 100%
rename from license-eye/pkg/comments/config_test.go
rename to pkg/comments/config_test.go
diff --git a/license-eye/pkg/config/config.go b/pkg/config/config.go
similarity index 100%
rename from license-eye/pkg/config/config.go
rename to pkg/config/config.go
diff --git a/license-eye/pkg/deps/config.go b/pkg/deps/config.go
similarity index 100%
rename from license-eye/pkg/deps/config.go
rename to pkg/deps/config.go
diff --git a/license-eye/pkg/deps/golang.go b/pkg/deps/golang.go
similarity index 100%
rename from license-eye/pkg/deps/golang.go
rename to pkg/deps/golang.go
diff --git a/license-eye/pkg/deps/resolve.go b/pkg/deps/resolve.go
similarity index 100%
rename from license-eye/pkg/deps/resolve.go
rename to pkg/deps/resolve.go
diff --git a/license-eye/pkg/deps/result.go b/pkg/deps/result.go
similarity index 100%
rename from license-eye/pkg/deps/result.go
rename to pkg/deps/result.go
diff --git a/license-eye/pkg/header/check.go b/pkg/header/check.go
similarity index 100%
rename from license-eye/pkg/header/check.go
rename to pkg/header/check.go
diff --git a/license-eye/pkg/header/check_test.go b/pkg/header/check_test.go
similarity index 100%
rename from license-eye/pkg/header/check_test.go
rename to pkg/header/check_test.go
diff --git a/license-eye/pkg/header/config.go b/pkg/header/config.go
similarity index 100%
rename from license-eye/pkg/header/config.go
rename to pkg/header/config.go
diff --git a/license-eye/pkg/header/fix.go b/pkg/header/fix.go
similarity index 100%
rename from license-eye/pkg/header/fix.go
rename to pkg/header/fix.go
diff --git a/license-eye/pkg/header/fix_test.go b/pkg/header/fix_test.go
similarity index 100%
rename from license-eye/pkg/header/fix_test.go
rename to pkg/header/fix_test.go
diff --git a/license-eye/pkg/header/result.go b/pkg/header/result.go
similarity index 100%
rename from license-eye/pkg/header/result.go
rename to pkg/header/result.go
diff --git a/license-eye/pkg/license/identifier.go b/pkg/license/identifier.go
similarity index 100%
rename from license-eye/pkg/license/identifier.go
rename to pkg/license/identifier.go
diff --git a/license-eye/pkg/license/norm.go b/pkg/license/norm.go
similarity index 100%
rename from license-eye/pkg/license/norm.go
rename to pkg/license/norm.go
diff --git a/license-eye/pkg/license/norm_test.go b/pkg/license/norm_test.go
similarity index 100%
rename from license-eye/pkg/license/norm_test.go
rename to pkg/license/norm_test.go
diff --git a/license-eye/pkg/review/header.go b/pkg/review/header.go
similarity index 100%
rename from license-eye/pkg/review/header.go
rename to pkg/review/header.go
diff --git a/quality-eye/README.md b/quality-eye/README.md
deleted file mode 100644
index c8246fc..0000000
--- a/quality-eye/README.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# Quality Eye - NGE2E
-
-NGE2E is the next generation End-to-End Testing framework that aims to help
developers to set up, debug, and verify E2E tests with ease. It’s built based
on the lessons learnt from tens of hundreds of test cases in the SkyWalking
main repo.
-
-**[Design doc](https://skywalking.apache.org/blog/e2e-design/).**
diff --git a/license-eye/test/config_test.go b/test/config_test.go
similarity index 100%
rename from license-eye/test/config_test.go
rename to test/config_test.go
diff --git a/license-eye/test/testdata/.licenserc_for_test_check.yaml
b/test/testdata/.licenserc_for_test_check.yaml
similarity index 100%
rename from license-eye/test/testdata/.licenserc_for_test_check.yaml
rename to test/testdata/.licenserc_for_test_check.yaml
diff --git a/license-eye/test/testdata/.licenserc_for_test_fix.yaml
b/test/testdata/.licenserc_for_test_fix.yaml
similarity index 100%
rename from license-eye/test/testdata/.licenserc_for_test_fix.yaml
rename to test/testdata/.licenserc_for_test_fix.yaml
diff --git a/license-eye/test/testdata/exclude_test/directories/testcase.go
b/test/testdata/exclude_test/directories/testcase.go
similarity index 100%
rename from license-eye/test/testdata/exclude_test/directories/testcase.go
rename to test/testdata/exclude_test/directories/testcase.go
diff --git a/license-eye/test/testdata/exclude_test/extensions/testcase.json
b/test/testdata/exclude_test/extensions/testcase.json
similarity index 100%
rename from license-eye/test/testdata/exclude_test/extensions/testcase.json
rename to test/testdata/exclude_test/extensions/testcase.json
diff --git a/license-eye/test/testdata/exclude_test/extensions/testcase.md
b/test/testdata/exclude_test/extensions/testcase.md
similarity index 100%
rename from license-eye/test/testdata/exclude_test/extensions/testcase.md
rename to test/testdata/exclude_test/extensions/testcase.md
diff --git a/license-eye/test/testdata/exclude_test/extensions/testcase.xml
b/test/testdata/exclude_test/extensions/testcase.xml
similarity index 100%
rename from license-eye/test/testdata/exclude_test/extensions/testcase.xml
rename to test/testdata/exclude_test/extensions/testcase.xml
diff --git a/license-eye/test/testdata/include_test/with_license/testcase.go
b/test/testdata/include_test/with_license/testcase.go
similarity index 100%
rename from license-eye/test/testdata/include_test/with_license/testcase.go
rename to test/testdata/include_test/with_license/testcase.go
diff --git
a/license-eye/test/testdata/include_test/with_license/testcase.graphql
b/test/testdata/include_test/with_license/testcase.graphql
similarity index 100%
rename from license-eye/test/testdata/include_test/with_license/testcase.graphql
rename to test/testdata/include_test/with_license/testcase.graphql
diff --git a/license-eye/test/testdata/include_test/with_license/testcase.java
b/test/testdata/include_test/with_license/testcase.java
similarity index 100%
rename from license-eye/test/testdata/include_test/with_license/testcase.java
rename to test/testdata/include_test/with_license/testcase.java
diff --git a/license-eye/test/testdata/include_test/with_license/testcase.ml
b/test/testdata/include_test/with_license/testcase.ml
similarity index 100%
rename from license-eye/test/testdata/include_test/with_license/testcase.ml
rename to test/testdata/include_test/with_license/testcase.ml
diff --git a/license-eye/test/testdata/include_test/with_license/testcase.py
b/test/testdata/include_test/with_license/testcase.py
similarity index 100%
rename from license-eye/test/testdata/include_test/with_license/testcase.py
rename to test/testdata/include_test/with_license/testcase.py
diff --git a/license-eye/test/testdata/include_test/with_license/testcase.sh
b/test/testdata/include_test/with_license/testcase.sh
similarity index 100%
rename from license-eye/test/testdata/include_test/with_license/testcase.sh
rename to test/testdata/include_test/with_license/testcase.sh
diff --git a/license-eye/test/testdata/include_test/with_license/testcase.yaml
b/test/testdata/include_test/with_license/testcase.yaml
similarity index 100%
rename from license-eye/test/testdata/include_test/with_license/testcase.yaml
rename to test/testdata/include_test/with_license/testcase.yaml
diff --git a/license-eye/test/testdata/include_test/with_license/testcase.yml
b/test/testdata/include_test/with_license/testcase.yml
similarity index 100%
rename from license-eye/test/testdata/include_test/with_license/testcase.yml
rename to test/testdata/include_test/with_license/testcase.yml
diff --git a/license-eye/test/testdata/include_test/without_license/testcase.go
b/test/testdata/include_test/without_license/testcase.go
similarity index 100%
rename from license-eye/test/testdata/include_test/without_license/testcase.go
rename to test/testdata/include_test/without_license/testcase.go
diff --git
a/license-eye/test/testdata/include_test/without_license/testcase.graphql
b/test/testdata/include_test/without_license/testcase.graphql
similarity index 100%
rename from
license-eye/test/testdata/include_test/without_license/testcase.graphql
rename to test/testdata/include_test/without_license/testcase.graphql
diff --git
a/license-eye/test/testdata/include_test/without_license/testcase.java
b/test/testdata/include_test/without_license/testcase.java
similarity index 100%
rename from license-eye/test/testdata/include_test/without_license/testcase.java
rename to test/testdata/include_test/without_license/testcase.java
diff --git a/license-eye/test/testdata/include_test/without_license/testcase.md
b/test/testdata/include_test/without_license/testcase.md
similarity index 100%
rename from license-eye/test/testdata/include_test/without_license/testcase.md
rename to test/testdata/include_test/without_license/testcase.md
diff --git a/license-eye/test/testdata/include_test/without_license/testcase.py
b/test/testdata/include_test/without_license/testcase.py
similarity index 100%
rename from license-eye/test/testdata/include_test/without_license/testcase.py
rename to test/testdata/include_test/without_license/testcase.py
diff --git a/license-eye/test/testdata/include_test/without_license/testcase.sh
b/test/testdata/include_test/without_license/testcase.sh
similarity index 100%
rename from license-eye/test/testdata/include_test/without_license/testcase.sh
rename to test/testdata/include_test/without_license/testcase.sh
diff --git
a/license-eye/test/testdata/include_test/without_license/testcase.yaml
b/test/testdata/include_test/without_license/testcase.yaml
similarity index 100%
rename from license-eye/test/testdata/include_test/without_license/testcase.yaml
rename to test/testdata/include_test/without_license/testcase.yaml
diff --git
a/license-eye/test/testdata/include_test/without_license/testcase.yml
b/test/testdata/include_test/without_license/testcase.yml
similarity index 100%
rename from license-eye/test/testdata/include_test/without_license/testcase.yml
rename to test/testdata/include_test/without_license/testcase.yml
diff --git a/license-eye/test/testdata/test-spdx-asf.yaml
b/test/testdata/test-spdx-asf.yaml
similarity index 100%
rename from license-eye/test/testdata/test-spdx-asf.yaml
rename to test/testdata/test-spdx-asf.yaml
diff --git a/license-eye/test/testdata/test-spdx.yaml
b/test/testdata/test-spdx.yaml
similarity index 100%
rename from license-eye/test/testdata/test-spdx.yaml
rename to test/testdata/test-spdx.yaml
![http://skywalking.apache.org/assets/logo.svg"](http://skywalking.apache.org/assets/logo.svg"){kind=link}
