Clearer warnings in license review #9134
Merged
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
…tal (as they were breaking anyway)
radeusgd
added
the
CI: No changelog needed
radeusgd
requested review from
jdunkerley,
GregoryTravis,
AdRiley,
4e6,
JaroslavTulach,
hubertp and
mwu-tow
as code owners
Akirathan
approved these changes
Feb 23, 2024
…better-warnings-in-license-review
AdRiley
approved these changes
Feb 26, 2024
hubertp
approved these changes
Feb 27, 2024
Comment on lines
179
to
181
| s"A license file was discovered in $name that is different " + | ||
| s"from the default license file that is associated with its " + | ||
| s"license ${dep.information.license.name}, but a custom license was not expected. If this custom license should override the default one, create a `custom-license` config file. If both files are expected to be included, create an empty `default-and-custom-license` file." |
There was a problem hiding this comment.
Suggested change
| s"A license file was discovered in $name that is different " + | |
| s"from the default license file that is associated with its " + | |
| s"license ${dep.information.license.name}, but a custom license was not expected. If this custom license should override the default one, create a `custom-license` config file. If both files are expected to be included, create an empty `default-and-custom-license` file." | |
| s"""|A license file was discovered in $name that is different | |
| |from the default license file that is associated with its | |
| |license ${dep.information.license.name}, but a custom license was not expected. If this custom license should override the default one, create a `custom-license` config file. If both files are expected to be included, create an empty `default-and-custom-license` file.""".stripMargin |
There was a problem hiding this comment.
This will add newlines into the string, whereas before the string was a single line.
| s"No files or copyright information are included for $name." | ||
| diagnostics.append( | ||
| Diagnostic.Problem( | ||
| s"No files or copyright information are included for $name. Generally every dependency should have _some_ copyright info, so this suggests all our heuristics failed. Please find the information manually and add it using `files-add` or `copyright-add`. Even if the dependency is public domain, it may be good to include some information about its source." |
Thanks @hubertp for the suggestions, I've applied them. |
mergify
bot
deleted the
wip/radeusgd/9120-better-warnings-in-license-review
branch
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.
Pull Request Description
Important Notes
Checklist
Please ensure that the following checklist has been satisfied before submitting the PR:
Scala,
Java,
and
Rust
style guides. In case you are using a language not listed above, follow the Rust style guide.
./run ide build.