fix: add error message for github PR url in dep by joshka · Pull Request #15003 · rust-lang/cargo

joshka · 2025-01-02T05:59:41Z

Prior to this, using a github PR URL would cause cargo to attempt to
fetch from an incorrect URL several times before failing.
Providing a github pull request url now fails with an error message
that shows how to fix the problem.

E.g.:

bar = { git = "https://github.com/foo/bar/pull/123" }

Now gives the following error message:

dependency (bar) specifies a GitHub pull request link. If you were trying to specify a specific github PR, replace the URL with the git URL (e.g. `git = "https://github.com/foo/bar.git"`) and add `rev = "refs/pull/123/head"` in the dependency declaration.

Fixes: #15001

Prior to this, using a github PR URL would cause cargo to attempt to fetch from an incorrect URL several times before failing. Providing a github pull request url now fails with an error message that shows how to fix the problem. E.g.: ```toml bar = { git = "https://github.com/foo/bar/pull/123" } ``` Now gives the following error message: ``` dependency (bar) specifies a GitHub pull request link. If you were trying to specify a specific github PR, replace the URL with the git URL (e.g. `git = "https://github.com/foo/bar.git"`) and add `rev = "refs/pull/123/head"` in the dependency declaration. ``` Fixes: rust-lang#15001

rustbot · 2025-01-02T05:59:47Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @weihanglo (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

tests/testsuite/bad_config.rs

src/cargo/util/toml/mod.rs

tests/testsuite/bad_config.rs

weihanglo

Thanks! If needed, we can iterate it later :)

joshka · 2025-01-09T22:45:20Z

I'm not quite sure what the right approach to getting the tests to succeed both in CI and locally for this change. Any guidance?

weihanglo · 2025-01-09T23:18:17Z

tests/testsuite/bad_config.rs

+[WARNING] spurious network error (3 tries remaining): unexpected http status code: 404; class=Http (34)
+[WARNING] spurious network error (2 tries remaining): unexpected http status code: 404; class=Http (34)
+[WARNING] spurious network error (1 tries remaining): unexpected http status code: 404; class=Http (34)
+[ERROR] failed to get `bar` as a dependency of package `foo v0.0.0 ([ROOT]/foo)`
+
+Caused by:
+  failed to load source for dependency `bar`
+
+Caused by:
+  Unable to update https://github.com/foo/bar/pull/123
+
+Caused by:
+  failed to clone into: [ROOT]/home/.cargo/git/db/123-[HASH]
+
+Caused by:
+  network failure seems to have happened
+  if a proxy or similar is necessary `net.git-fetch-with-cli` may help here
+  https://doc.rust-lang.org/cargo/reference/config.html#netgit-fetch-with-cli
+
+Caused by:
+  unexpected http status code: 404; class=Http (34)


Interesting. I thought it was network flakiness. Anyway, you can use ... to omit the unimportant part.

Suggested change

[WARNING] spurious network error (3 tries remaining): unexpected http status code: 404; class=Http (34)

[WARNING] spurious network error (2 tries remaining): unexpected http status code: 404; class=Http (34)

[WARNING] spurious network error (1 tries remaining): unexpected http status code: 404; class=Http (34)

[ERROR] failed to get `bar` as a dependency of package `foo v0.0.0 ([ROOT]/foo)`

Caused by:

failed to load source for dependency `bar`

Caused by:

Unable to update https://github.com/foo/bar/pull/123

Caused by:

failed to clone into: [ROOT]/home/.cargo/git/db/123-[HASH]

Caused by:

network failure seems to have happened

if a proxy or similar is necessary `net.git-fetch-with-cli` may help here

https://doc.rust-lang.org/cargo/reference/config.html#netgit-fetch-with-cli

Caused by:

unexpected http status code: 404; class=Http (34)

...

[ERROR] failed to get `bar` as a dependency of package `foo v0.0.0 ([ROOT]/foo)`

Caused by:

failed to load source for dependency `bar`

Caused by:

Unable to update https://github.com/foo/bar/pull/123

...

This is the problem with not making this change cause an error. If this is a warning, then after emitting the warning, cargo will attempt to load the github PR url, which is not a git repo, and so that attempt will 404 or some other error (e.g. not a git repo). I think that ... change would make sense though, so committing it as is.

PS. feel free to squash this commit (I know Ed prefers atomic commits in the shape that will end up in the repo, but this is really a single change - not sure how that applies to this project).

[patch] test also needs the same trick :)

Co-authored-by: Weihang Lo <weihanglo@users.noreply.github.com>

epage · 2025-01-10T02:21:22Z

Sorry I've not been able to get back to this and thanks @weihanglo for picking it up.

A non-blocking thought (since some improvement is better than no improvement) is to offer something similar for cargo add --git URL

weihanglo · 2025-03-01T18:23:16Z

@rustbot author

motorailgun · 2025-09-29T16:44:30Z

@joshka Sorry for heads-up, wondering if you're still working on this? Would you mind if I take over this PR?

joshka · 2025-11-03T06:41:53Z

@joshka Sorry for heads-up, wondering if you're still working on this? Would you mind if I take over this PR?

Please do. I've been busy with life and not as available to get things like this over the line.

…16207) Succeeding #15003. Piror to this, using a GitHub pull request URLs as dependencies would just fail because of HTTP errors as it's simply not a git repository. This PR implements some help messages on such cases for users to know why it's failing, and how to fix it. Close #15001.

weihanglo · 2026-01-28T15:26:05Z

completed in #16207, closing

rustbot assigned weihanglo Jan 2, 2025

rustbot added A-manifest Area: Cargo.toml issues S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 2, 2025

joshka mentioned this pull request Jan 2, 2025

Allow specifying pull request deps using the github PR link #15001

Closed

epage reviewed Jan 2, 2025

View reviewed changes

tests/testsuite/bad_config.rs Show resolved Hide resolved

epage reviewed Jan 2, 2025

View reviewed changes

src/cargo/util/toml/mod.rs Outdated Show resolved Hide resolved

epage reviewed Jan 2, 2025

View reviewed changes

tests/testsuite/bad_config.rs Outdated Show resolved Hide resolved

joshka added 2 commits January 2, 2025 16:45

fix: tweak message and add test for patch

d743987

Replace error with warning

85c9387

joshka force-pushed the jm/git-pr-url branch from fe028a0 to 85c9387 Compare January 9, 2025 08:11

weihanglo approved these changes Jan 9, 2025

View reviewed changes

weihanglo enabled auto-merge January 9, 2025 14:08

weihanglo reviewed Jan 9, 2025

View reviewed changes

make test agnostic about exact network failure reason.

a27647d

Co-authored-by: Weihang Lo <weihanglo@users.noreply.github.com>

auto-merge was automatically disabled January 9, 2025 23:25
Head branch was pushed to by a user without write access

rustbot added S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 1, 2025

motorailgun mentioned this pull request Nov 5, 2025

feat: emit help messages for github pull request url in dependency #16207

Merged

weihanglo closed this Jan 28, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: add error message for github PR url in dep#15003

fix: add error message for github PR url in dep#15003
joshka wants to merge 4 commits intorust-lang:masterfrom
joshka:jm/git-pr-url

joshka commented Jan 2, 2025

Uh oh!

rustbot commented Jan 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weihanglo left a comment

Uh oh!

joshka commented Jan 9, 2025

Uh oh!

weihanglo Jan 9, 2025

Uh oh!

joshka Jan 9, 2025

Uh oh!

weihanglo Jan 10, 2025

Uh oh!

epage commented Jan 10, 2025

Uh oh!

weihanglo commented Mar 1, 2025

Uh oh!

motorailgun commented Sep 29, 2025

Uh oh!

joshka commented Nov 3, 2025

Uh oh!

weihanglo commented Jan 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

joshka commented Jan 2, 2025

Uh oh!

rustbot commented Jan 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weihanglo left a comment

Choose a reason for hiding this comment

Uh oh!

joshka commented Jan 9, 2025

Uh oh!

weihanglo Jan 9, 2025

Choose a reason for hiding this comment

Uh oh!

joshka Jan 9, 2025

Choose a reason for hiding this comment

Uh oh!

weihanglo Jan 10, 2025

Choose a reason for hiding this comment

Uh oh!

epage commented Jan 10, 2025

Uh oh!

weihanglo commented Mar 1, 2025

Uh oh!

motorailgun commented Sep 29, 2025

Uh oh!

joshka commented Nov 3, 2025

Uh oh!

weihanglo commented Jan 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants