You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@skywalking.apache.org by ke...@apache.org on 2021/10/13 04:17:56 UTC
[skywalking-eyes] 01/01: Prepare 0.2.0 release
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch rel/0.2.0
in repository https://gitbox.apache.org/repos/asf/skywalking-eyes.git
commit 3b848f0d48d469625c8207d8982603008c37c95e
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Wed Oct 13 12:17:45 2021 +0800
Prepare 0.2.0 release
---
README.md | 36 +++++++++++++++++++++++++++++++++---
1 file changed, 33 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index b92fced..ceca9fb 100644
--- a/README.md
+++ b/README.md
@@ -85,8 +85,13 @@ go install github.com/apache/skywalking-eyes/cmd/license-eye@latest
#### Check License Header
```bash
-bin/darwin/license-eye -c test/testdata/.licenserc_for_test_check.yaml header check
+license-eye -c test/testdata/.licenserc_for_test_check.yaml header check
+```
+
+<details>
+<summary>Header Check Result</summary>
+```
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:
@@ -105,15 +110,24 @@ test/testdata/test-spdx.yaml
exit status 1
```
+</details>
+
#### Fix License Header
```bash
bin/darwin/license-eye -c test/testdata/.licenserc_for_test_fix.yaml header fix
+```
+<details>
+<summary>Header Fix Result</summary>
+
+```
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
```
+</details>
+
#### Resolve Dependencies' licenses
This command serves as assistance for human beings to audit the dependencies license, it's exit code is always 0.
@@ -122,7 +136,13 @@ You can also use the `--output` or `-o` to save the dependencies' `LICENSE` file
you can put them in distribution package if needed.
```bash
-bin/darwin/license-eye -c test/testdata/.licenserc_for_test_check.yaml dep resolve -o ./dependencies/licenses
+license-eye -c test/testdata/.licenserc_for_test_check.yaml dep resolve -o ./dependencies/licenses
+```
+
+<details>
+<summary>Dependency Resolve Result</summary>
+
+```
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
@@ -312,13 +332,21 @@ github.com/russross/blackfriday/v2
gopkg.in/check.v1
```
+</details>
+
#### Check Dependencies' licenses
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.
```bash
-bin/darwin/license-eye -c test/testdata/.licenserc_for_test_check.yaml dep check
+license-eye -c test/testdata/.licenserc_for_test_check.yaml dep check
+```
+
+<details>
+<summary>Dependency Check Result</summary>
+
+```
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
@@ -339,6 +367,8 @@ License: Unknown Dependency: gopkg.in/check.v1
exit status 1
```
+</details>
+
## Configurations
```yaml