Skip to content

Respect package.readme in Cargo.toml#1298

Merged
drager merged 1 commit intodrager:masterfrom
heaths:issue1215-redux
Jun 17, 2023
Merged

Respect package.readme in Cargo.toml#1298
drager merged 1 commit intodrager:masterfrom
heaths:issue1215-redux

Conversation

@heaths
Copy link
Contributor

@heaths heaths commented Jun 16, 2023

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_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.

Fixes drager#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.
@heaths
Copy link
Contributor Author

heaths commented Jun 16, 2023

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).

Copy link
Owner

@drager drager left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot!

@drager drager merged commit 78808ee into drager:master Jun 17, 2023
@heaths heaths deleted the issue1215-redux branch June 19, 2023 23:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Warning about no README when readme = false

2 participants