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

Jump to bottom

x/pkgsite: surface VCS clone path from the go-import meta tag #46243

Open
mvdan opened this issue May 18, 2021 · 4 comments
Open

x/pkgsite: surface VCS clone path from the go-import meta tag #46243

mvdan opened this issue May 18, 2021 · 4 comments
Labels
NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. pkgsite
Milestone
pkgsite/unplanned

Comments

@mvdan
Copy link
Member

mvdan commented May 18, 2021

Take golang.org/x/mod, for example:

$ curl https://golang.org/x/mod
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta name="go-import" content="golang.org/x/mod git https://go.googlesource.com/mod">
<meta name="go-source" content="golang.org/x/mod https://github.com/golang/mod/ https://github.com/golang/mod/tree/master{/dir} https://github.com/golang/mod/blob/master{/dir}/{file}#L{line}">
<meta http-equiv="refresh" content="0; url=https://pkg.go.dev/golang.org/x/mod">
</head>
<body>
<a href="https://pkg.go.dev/golang.org/x/mod">Redirecting to documentation...</a>
</body>
</html>

If I go to https://pkg.go.dev/golang.org/x/mod, the only link I see is https://github.com/golang/mod, which is fine for browsing the source - but not for git clone, as github is just a mirror. I should be using https://go.googlesource.com/mod for that, but pkgsite doesn't make that evident.

I get that perhaps this is an internal detail that most people shouldn't need to be aware of, but it's still relevant for peoplel wishing to contribute to a module. Especially for the x repos hosted by Gerrit - I seem to recall that you have to clone from the right URL for git-codereview to work properly.
@gopherbot gopherbot added this to the Unreleased milestone May 18, 2021
@bcmills
Copy link
Contributor

bcmills commented May 18, 2021

(Compare #18387 for cmd/go.)

@jba jba added the NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. label May 18, 2021
@jba jba modified the milestones: Unreleased, pkgsite/unplanned May 18, 2021
@bcmills bcmills mentioned this issue Aug 4, 2021
Closed
@bcmills
Copy link
Contributor

bcmills commented Aug 4, 2021

It may be that pkgsite itself doesn't have this information at the moment. (We may need #44742 for that.)

@dmitshur
Copy link
Contributor

dmitshur commented Aug 4, 2021

I've closed #47520 as a duplicate of this issue.

@shellscape
Copy link

shellscape commented Oct 7, 2021 •
edited

Please resurface that meta tag, as it was infinitely useful for anyone performing insight on their imports. Vanity paths have no other means of gleaning information on the repo other than to scrape HTML. Combined with the lack of an API to provide package metadata, the new site and forced redirect cripple consumer insight into packages.

I'd also suggest placing any other useful information into meta tags in lieu of an API. That's at least somewhat functional and quasi-contractual.

@bcmills bcmills mentioned this issue Jan 26, 2022
Closed
@bcmills bcmills mentioned this issue Dec 2, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. pkgsite
Projects
None yet
Milestone
pkgsite/unplanned
Development

No branches or pull requests
6 participants
@shellscape @dmitshur @mvdan @bcmills @gopherbot @jba