Respect package.readme in Cargo.toml #1298
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
Fixes rustwasm#1215 by honoring how package.readme is authored in Cargo.toml, if authored. This could be a path or a boolean to disable searching for the path. Also fixes the existing `it_copies_a_readme_provided_path` test which was an exact copy - just with fewer empty lines - of `it_copies_a_readme_default_path` and wasn't honoring any authored path since there was no way to get the authored path.
|
This fixes some issues with a couple tests that were actually broken before the original PR this replaces. Looking at old runs, it seems that they were effectively broken when the change was made to stop deserializing the manifest in this crate directly and to use a tool instead. Maybe the breaks in the tests weren't fully exposed then - though there were subsequent build breaks exactly the same as after the original PR for this change - but I am happy to fix them because they certainly are related to what I was trying to achieve here: to ignore when a README was explicitly disabled (as I'd expect for a wasm). |
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.
Fixes #1215 by honoring how package.readme is authored in Cargo.toml, if authored. This could be a path or a boolean to disable searching for the path.
Also fixes the existing
it_copies_a_readme_provided_pathtest which was an exact copy - just with fewer empty lines - ofit_copies_a_readme_default_pathand wasn't honoring any authored path since there was no way to get the authored path.