[Docs] add the usage for config the license header comment style. #99
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kezhenxu94
reviewed
Apr 9, 2022
| @@ -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. | |||
README.md
Outdated
| 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`. |
There was a problem hiding this comment.
Can you add your use case (using block comment style in Go codes) as an example here? See my suggestion below
README.md
Outdated
| 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`. |
There was a problem hiding this comment.
Suggested change
| 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`. | |
| 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) |
There was a problem hiding this comment.
Hi @kezhenxu94 , Thanks for your reply, I will fix it.
There was a problem hiding this comment.
Hi @kezhenxu94 , I fix the content, please review it again, Thanks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.