You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by GitBox <gi...@apache.org> on 2022/04/09 10:16:41 UTC
[GitHub] [skywalking-eyes] kezhenxu94 commented on a diff in pull request #99: [Docs] add the usage for config the license header comment style.
kezhenxu94 commented on code in PR #99:
URL: https://github.com/apache/skywalking-eyes/pull/99#discussion_r846612213
##########
README.md:
##########
@@ -467,8 +478,14 @@ dependency: # <9>
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.mod` 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`.
+9. The `license-location-threshold` specifies the index threshold where the license header can be located.
+10. The `language` is an optional configuration. You can set the language license header comment style, if it doesn't exist, it will use the default configuration at the `languages.yaml`.
Review Comment:
Can you add your use case (using block comment style in Go codes) as an example here? See my suggestion below
##########
README.md:
##########
@@ -467,8 +478,14 @@ dependency: # <9>
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.mod` 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`.
+9. The `license-location-threshold` specifies the index threshold where the license header can be located.
+10. The `language` is an optional configuration. You can set the language license header comment style, if it doesn't exist, it will use the default configuration at the `languages.yaml`.
Review Comment:
```suggestion
10. The `language` is an optional configuration. You can set the language license header comment style. If it doesn't exist, it will use the default configuration at the `languages.yaml`. An example is to use block comment style for Go codes. (Link to the example configuration)
```
##########
README.md:
##########
@@ -467,8 +478,14 @@ dependency: # <9>
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.mod` 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`.
+9. The `license-location-threshold` specifies the index threshold where the license header can be located.
Review Comment:
Thanks for adding this 👍
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org