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

x/pkgsite: package removal request forgithub.com/shopify/sarama #52192

Open
dethi opened this issue Apr 6, 2022 · 1 comment
Open

x/pkgsite: package removal request forgithub.com/shopify/sarama #52192

dethi opened this issue Apr 6, 2022 · 1 comment
Labels
NeedsInvestigation pkgsite

Comments

@dethi
Copy link

@dethi dethi commented Apr 6, 2022

What is the path of the package that you would like to have removed?

github.com/shopify/sarama

Are you the owner of this package?

No, but please read the reason bellow.

What is the reason that you could not retract this package instead?

The package is present twice in the index, once as Shopify/sarama and another as shopify/sarama.

https://pkg.go.dev/github.com/shopify/sarama -> hasn't indexed any version since 2019
https://pkg.go.dev/github.com/Shopify/sarama -> actually show the latest version (v1.32.0)

The correct casing should be Shopify/sarama (github.com/Shopify/sarama). I'm not sure why both versions are present in the index, but this is confusing user looking for the latest documentation.

A simple Google search returns shopify/sarama as first result instead of Shopify/sarama:
Screenshot 2022-04-06 at 23 39 29

@dethi dethi added the pkgsite label Apr 6, 2022
@gopherbot gopherbot added this to the pkgsite/unplanned milestone Apr 6, 2022
@jamalc jamalc added the NeedsInvestigation label Apr 8, 2022
@seankhliao seankhliao changed the title x/pkgsite: package removal request for [type path here] x/pkgsite: package removal request forgithub.com/shopify/sarama Apr 8, 2022
@jba
Copy link
Contributor

@jba jba commented Apr 12, 2022

We look inside the go.mod file and reject a module if the path that led us to it does not match the path in the go.mod file. So if you look for a module or package using different capitalization, and all versions of that path had a go.mod file, then we should say that we can't find it. (Should we instead redirect to the proper case? That's an open question.)

If a package predates modules, then we have the situation with Shopify/sarama. Without a go.mod file we can't tell which is the "true" import path of the module, indeed that's not really well-defined in the pre-module world. So we will show the package with whatever case we see it (whatever the module proxy and its index give us).

The go.mod file for this module says "Shopify", which is why that spelling gives you the latest version. But up to version 1.20.1, there was no go.mod file, so we still display the "shopify" spelling.

Should we drop the old versions? It's unclear; someone could be using them, and may want docs at that version under the spelling they're familiar with. At some point that benefit outweighs the confusion. As modules dominate the Go ecosystem, the old non-module versions will become irrelevant, and we can drop them. v1.20.1 of Shopify/sarama is over three years old, so I would be comfortable dropping it, but if there were newer non-module versions of package I might feel differently.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NeedsInvestigation pkgsite
Projects
None yet
Development

No branches or pull requests

4 participants