Log missing conventional README at debug level#5258
Open
Sanjays2402 wants to merge 1 commit into
Open
Conversation
Projects may configure a nonstandard readme in pyproject.toml, but sdist.check_readme emitted its informational fallback through Command.warn. Emit the diagnostic at debug level and cover its severity with a regression test. Fixes pypa#4122
Contributor
|
Tick the box to add this pull request to the merge queue (same as
|
Author
|
@Mergifyio queue |
Contributor
☑️ Command disallowed due to command restrictions in the Mergify configuration.Details
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary of changes
The
sdistcommand currently emits a warning when none of the conventional README filenames are present. That diagnostic is informational rather than actionable, and it can be misleading for projects that intentionally use a nonstandard README filename.This changes the diagnostic from warning to debug output, keeping it available for troubleshooting without showing it during normal builds. It also adds a regression test that verifies the message is logged at the debug level.
Closes #4122
Pull Request Checklist
newsfragments/.(See documentation for details)