Skip to content

Conversation

@kivikakk
Copy link
Contributor

This is required to solve rust-lang/crates.io#995; we currently only send the README content, but not the name of the README itself, so it's not possible to determine how we should render it.

I've confirmed the existing crates.io server silently ignores the new field, so this should be safe to roll out whenever.

@rust-highfive
Copy link

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @matklad (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@alexcrichton
Copy link
Member

r? @carols10cents

(looks good to me otherwise!)

@carols10cents
Copy link
Member

Yay! lgtm!!

@bors: r+

@bors
Copy link
Contributor

bors commented Oct 18, 2017

📌 Commit 76a69b4 has been approved by carols10cents

@bors
Copy link
Contributor

bors commented Oct 18, 2017

⌛ Testing commit 76a69b4 with merge 757c3fa...

bors added a commit that referenced this pull request Oct 18, 2017
transmit: send README filename as well as content

This is required to solve rust-lang/crates.io#995; we currently only send the README content, but not the name of the README itself, so it's not possible to determine how we should render it.

I've confirmed the existing crates.io server silently ignores the new field, so this should be safe to roll out whenever.
@bors
Copy link
Contributor

bors commented Oct 18, 2017

☀️ Test successful - status-appveyor, status-travis
Approved by: carols10cents
Pushing 757c3fa to master...

@bors bors merged commit 76a69b4 into rust-lang:master Oct 18, 2017
@kivikakk kivikakk deleted the readme-file branch October 18, 2017 13:19
bors-voyager bot added a commit to rust-lang/crates.io that referenced this pull request Oct 25, 2017
1134: Record readme filename; use to determine whether to render as Markdown or not r=carols10cents

Fixes #995. Depends on rust-lang/cargo#4633 to have the desired effect, but won't break in the absence of that PR; we'll just assume the readme is called `"README.md"` if the client doesn't report one.

Small CSS fix included to wrap extra long lines.

Comparison of render of https://crates.io/crates/relm's README:

| Before | After |
| :-: | :-: |
| ![screen shot 2017-10-17 at 5 51 50 pm](https://user-images.githubusercontent.com/1915/31650690-42018c7a-b364-11e7-95f8-7e1b8e8d56a0.png) | ![screen shot 2017-10-17 at 5 51 51 pm](https://user-images.githubusercontent.com/1915/31650698-44d16588-b364-11e7-92cf-1c3201c0e60e.png) |
@ehuss ehuss added this to the 1.23.0 milestone Feb 6, 2022
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.

7 participants