Configurable Description-Content-Type #360
Conversation
No validation is performed. The defaults are unchanged (and inconsistent with setuptools/PyPI). Basic test for checking metadata gets through.
clbarnes
changed the title
src/metadata.rs
Outdated
| let actual = metadata.to_file_contents(); | ||
|
|
||
| if actual.trim() != expected.trim() { | ||
| panic!( |
There was a problem hiding this comment.
You can pass a message and formatter options as third and following parameters to assert_eq (example)
There was a problem hiding this comment.
Good point, that was a leftover from a slightly different implementation, I'll change that.
src/metadata.rs
Outdated
| version = "0.1.0" | ||
| description = "A test project" | ||
| homepage = "https://example.org" | ||
| readme = "readme.md" |
There was a problem hiding this comment.
It could be but it doesn't have to be, as this test just needs to prove that the metadata gets through. I'll fix it for clarity, though.
There was a problem hiding this comment.
On second look, it doesn't actually matter because the substring is replaced by the path of the temporary file created to write the readme contents into; I've changed the name to make that more clear, as well as explicitly checking for some expected hardcoded values.
|
Thank you for the pull request! I like adding the |
Should be easy enough! |
... if not explicitly given. BREAKING: when no type is given AND the file does not have a recognised extension, maturin will now default to plaintext. This makes more sense, but is technically a breaking change.
|
Note fef38f8 - where no content type is given, and the file path does not have a known extension, content type defaults to plaintext rather than GFM. I think this makes most sense and the results shouldn't be disastrous (as markdown should be largely readable in plain text), but it is technically a breaking change. There's a little hole in the testing here because the existing tests write to and read from a file without an extension, so the end-to-end test for checking extensions is a bit tricky. But the filename-parsing logic is tested. |
|
Test failure relates to a missing GLIBC version, which I hope I'm not responsible for 😬 |
Thanks, that's definitely better than before!
Yep, iirc a recent rustc version dropped support for manylinux1 and I have to move it to manylinux2010. |
Using a newer version of maturin to properly set the description content type meta on built package. This functionality was intorduced in: PyO3/maturin#360
No validation is performed.
The defaults are unchanged (and inconsistent with setuptools/PyPI): that is, None if there is no readme, GFM if there is a readme and no explicit content type.
Basic test for checking metadata gets through.
See #247