Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Leverage readme_path to support relative paths from readme's not at root #3861

Merged
merged 1 commit into from
Sep 12, 2021

Conversation

nipunn1313
Copy link
Contributor

Added unit tests to confirm things work.
Manually tested end to end and confirmed that the rendered
page has a properly working relative link as long as the Cargo.toml
is in the root of the repo.

We'll need to update cargo as mentioned in #3484 in order to
support Cargo.toml that aren't in the root of the repo

@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 @smarnach (or someone else) soon.

Please see the contribution instructions for more information.

@nipunn1313
Copy link
Contributor Author

Here's me doing the best I can to show a screenshot of my manual test.
README is not in root (it's in docs/README.md). It has a relative link to ./Otherfile.md (also in docs)
Prior to this diff, the rendered MD->html would have a bad link. Now it looks good!
image

@Turbo87 Turbo87 added A-backend ⚙️ C-enhancement ✨ Category: Adding new behavior or a change to the way an existing feature works labels Aug 24, 2021
@bors
Copy link
Contributor

bors commented Aug 24, 2021

☔ The latest upstream changes (presumably #3862) made this pull request unmergeable. Please resolve the merge conflicts.

nipunn1313 added a commit to nipunn1313/cargo that referenced this pull request Aug 28, 2021
Added unit tests for publishing with
- cargo.toml in root + readme in root
- cargo.toml in root + readme in subdir
- cargo.toml in subdir + readme next to it
- cargo.toml in subdir + readme in root (../README)

Should fix rust-lang/crates.io#3484 in
combination with rust-lang/crates.io#3861
nipunn1313 added a commit to nipunn1313/cargo that referenced this pull request Sep 2, 2021
Added unit tests for publishing with
- cargo.toml in root + readme in root
- cargo.toml in root + readme in subdir
- cargo.toml in subdir + readme next to it
- cargo.toml in subdir + readme in root (../README)

Should fix rust-lang/crates.io#3484 in
combination with rust-lang/crates.io#3861
@bors
Copy link
Contributor

bors commented Sep 7, 2021

☔ The latest upstream changes (presumably #3880) made this pull request unmergeable. Please resolve the merge conflicts.

Added unit tests to confirm things work.
Manually tested end to end and confirmed that the rendered
page has a properly working relative link as long as the Cargo.toml
is in the root of the repo.

We'll need to update cargo as mentioned in rust-lang#3484 in order to
support Cargo.toml that aren't in the root of the repo
@nipunn1313
Copy link
Contributor Author

(rebased on master - to handle merge conflicts)

Copy link
Member

@Turbo87 Turbo87 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks! 👍

@Turbo87
Copy link
Member

Turbo87 commented Sep 12, 2021

@bors r+

@bors
Copy link
Contributor

bors commented Sep 12, 2021

📌 Commit cd4e08b has been approved by Turbo87

@bors
Copy link
Contributor

bors commented Sep 12, 2021

⌛ Testing commit cd4e08b with merge d0ee0cb...

@bors
Copy link
Contributor

bors commented Sep 12, 2021

☀️ Test successful - checks-actions
Approved by: Turbo87
Pushing d0ee0cb to master...

@bors bors merged commit d0ee0cb into rust-lang:master Sep 12, 2021
bors added a commit that referenced this pull request Sep 17, 2021
Extract `cio_markdown` subpackage

This allows us to isolate our markdown rendering code in a dedicated package, which could potentially have a positive effect on the compile times of the full project. It also means we can iterate on this part of the code independent from the other parts (see #3861 or #3297), and with a well-defined API interface.
@nipunn1313 nipunn1313 deleted the readme branch September 27, 2021 03:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-backend ⚙️ C-enhancement ✨ Category: Adding new behavior or a change to the way an existing feature works
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants