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:53:16 UTC
[skywalking-eyes] branch main updated: Prepare 0.2.0 release (#80)
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 c023972 Prepare 0.2.0 release (#80)
c023972 is described below
commit c023972107524554367f74b9ab658293238b80c2
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Wed Oct 13 12:53:11 2021 +0800
Prepare 0.2.0 release (#80)
---
CHANGES.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
README.md | 36 +++++++++++++++++++++++++++++++++---
2 files changed, 83 insertions(+), 3 deletions(-)
diff --git a/CHANGES.md b/CHANGES.md
index 7e84869..88f3fad 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1,3 +1,53 @@
+## 0.2.0
+
+- Dependency License
+ - Support resolving go.mod for Go
+ - Support resolving pom.xml for maven (#50)
+ - Support resolving jars' licenses (#53)
+ - Support resolving npm dependencies' licenses (#48)
+ - Support saving dependencies' licenses (#69)
+ - Add `dependency check` to check dependencies license compatibilities (#58)
+
+- License Header
+ - `fix` command supports more languages:
+ - Add support for plantuml (#42)
+ - Add support for PHP (#40)
+ - Add support for Twig template language (#39)
+ - Add support for Smarty template language (#38)
+ - Add support for MatLab files (#37)
+ - Add support for TypeScript language files (#73)
+ - Add support for nextflow files (#65)
+ - Add support for perl files (#63)
+ - Add support for ini extension (#24)
+ - Add support for R files (#64)
+ - Add support for .rst files and allow fixing header of a single file (#25)
+ - Add support for Rust files (#29)
+ - Add support for bat files (#32)
+ - Remove .tsx from XML language extensions
+ - Honor Python's coding directive (#68)
+ - Fix file extension conflict between RenderScript and Rust (#66)
+ - Add comment type to cython declaration (#62)
+ - header fix: respect user configured license content (#60)
+ - Expose `license-location-threshold` as config item (#34)
+ - Fix infinite recursive calls when containing symbolic files (#33)
+ - defect: avoid crash when no comment style is found (#23)
+
+- Project
+ - Enhance license identification (#79)
+ - Support installing via go install (#76)
+ - Speed up the initialization phase (#75)
+ - Resolve absolute path in `.gitignore` to relative path (#67)
+ - Reduce img size and add npm env (#59)
+ - Make the config file and log level in GitHub Action configurable (#56, #57)
+ - doc: add a PlantUML activity diagram of header fixing mechanism (#41)
+ - Fix bug: license file is not found but reported message is nil (#49)
+ - Add all well-known licenses and polish normalizers (#47)
+ - Fix compatibility issues in Windows (#44)
+ - feature: add reasonable default config to allow running in a new repo without copying config file (#28)
+ - chore: only build linux binary when building inside docker (#26)
+ - chore: upgrade to go 1.16 and remove `go-bindata` (#22)
+ - Add documentation about how to use via docker image (#20)
+
## 0.1.0
- License Header
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