fix(toml): Convert warnings that licence and readme files do not exist into errors
#13921
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
rustbot
added
Command-package
S-waiting-on-review
heisen-li
force-pushed
the
licence_readme_warning
branch
from
493e0f4
to
5c35e29
Compare
|
@bors try |
bors
added a commit
that referenced
this pull request
May 29, 2024
fix(toml): Convert warnings that `licence` and `readme` files do not exist into errors ### What does this PR try to resolve? In this PR: - Changed the warning to a hard error and modified the associated test function; - Removed what should have been a redundant test function：`publish::publish_with_missing_readme`； - Since `cargo publish` is preceded by the execution of `cargo package`, the error message in the test `function bad_license_file` needs to be modified. issue: #13629 (comment). ### Additional information It seems that this is not enough, the current situation is that `cargo package` warns if `package.readme` is an empty string or the wrong file location, but if I cancel `package.readme`, no warning is generated. I'm wondering if I should judge `package.readme&licence` when executing `cargo package` and return an error if it doesn't exist? As this has not been done before, your advice is sought.
|
💔 Test failed - checks-actions |
bors
added
S-waiting-on-author
|
@bors try |
bors
added a commit
that referenced
this pull request
May 29, 2024
fix(toml): Convert warnings that `licence` and `readme` files do not exist into errors ### What does this PR try to resolve? In this PR: - Changed the warning to a hard error and modified the associated test function; - Removed what should have been a redundant test function：`publish::publish_with_missing_readme`； - Since `cargo publish` is preceded by the execution of `cargo package`, the error message in the test `function bad_license_file` needs to be modified. issue: #13629 (comment). ### Additional information It seems that this is not enough, the current situation is that `cargo package` warns if `package.readme` is an empty string or the wrong file location, but if I cancel `package.readme`, no warning is generated. I'm wondering if I should judge `package.readme&licence` when executing `cargo package` and return an error if it doesn't exist? As this has not been done before, your advice is sought.
|
☀️ Try build successful - checks-actions |
weihanglo
reviewed
May 31, 2024
| license || license_file, | ||
| documentation || homepage || repository | ||
| ); | ||
| lacking!(description, documentation || homepage || repository); |
There was a problem hiding this comment.
Why did license || license_file part get removed? It is still required to have license specified.
| let rel_msg = if path.is_absolute() { | ||
| "".to_string() | ||
| } else { | ||
| format!(" (relative to `{}`)", pkg.root().display()) | ||
| }; | ||
| ws.gctx().shell().warn(&format!( | ||
|
|
||
| let msg = format!( |
There was a problem hiding this comment.
Cargo checks only two fields, so it is fine just returning an Err here . That would make the code easier to reason.
There was a problem hiding this comment.
Hard error, even for empty string
Should we add test checking empty string like license-file = "" or readme = "" will fail?
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.
What does this PR try to resolve?
In this PR:
publish::publish_with_missing_readme；cargo publishis preceded by the execution ofcargo package, the error message in the testfunction bad_license_fileneeds to be modified.issue: #13629 (comment).
Additional information
It seems that this is not enough, the current situation is that
cargo packagewarns ifpackage.readmeis an empty string or the wrong file location, but if I cancelpackage.readme, no warning is generated.I'm wondering if I should judge
package.readme&licencewhen executingcargo packageand return an error if it doesn't exist?As this has not been done before, your advice is sought.