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: package removal request for github.com/open-policy-agent/OPA #58925

Closed
charlieegan3 opened this issue Mar 8, 2023 · 5 comments
Closed

x/pkgsite: package removal request for github.com/open-policy-agent/OPA #58925

charlieegan3 opened this issue Mar 8, 2023 · 5 comments
Labels
FrozenDueToAge pkgsite/package-removal Issues for package removal. See https://pkg.go.dev/about#removing-a-package pkgsite WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided.
Milestone
Unreleased

Comments

@charlieegan3
Copy link

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

github.com/open-policy-agent/OPA (note uppercase OPA)

Are you the owner of this package?

I am a maintainer of the OPA project.

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

We are looking to remove a package rather than particular versions.

Notes

We seem to have ended up with two packages for the OPA project:

We would like to point users to the correct one at: github.com/open-policy-agent/opa but are unsure how best to go about this. Hopefully this is the right place 🙏
@gopherbot gopherbot added this to the Unreleased milestone Mar 8, 2023
@seankhliao seankhliao added the pkgsite/package-removal Issues for package removal. See https://pkg.go.dev/about#removing-a-package label Mar 8, 2023
@bcmills
Copy link
Contributor

bcmills commented Mar 8, 2023

We would like to point users to the correct one at: github.com/open-policy-agent/opa but are unsure how best to go about this.

The canonical module path is what is declared in the go.mod file. It looks like [github.com/open-policy-agent/opa](https://pkg.go.dev/github.com/open-policy-agent/opa) added a go.mod file with the current path as of v0.15.0.

Both paths resolve to the same underlying repo and the go command intentionally disregards the module path when processing retract directives, so it should suffice to retract all versions prior to v0.15.0 in the go.mod file at the repo root and publish those retractions in some tagged release (such as v0.49.3 or v0.50.0).

@bcmills bcmills added the WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided. label Mar 8, 2023
@charlieegan3
Copy link
Author

Thanks @bcmills! I think we can do that. I presumed that since the module path was different that we were in some edge case here. I’ll reopen if we still have the issue after adding the retracts.

@charlieegan3 charlieegan3 mentioned this issue Mar 9, 2023
Merged
charlieegan3 added a commit to open-policy-agent/opa that referenced this issue Mar 9, 2023
@charlieegan3
Retract pre go module OPA versions (#5741)
f24f18e 
We have two versions of our go package docs showing in https://pkg.go.dev/.

A) open-policy-agent/OPA &
B) https://pkg.go.dev/github.com/open-policy-agent/opa

A appears to contain only versions up to 0.15.0 where we started using
go modules. B is the correct one we want to keep using.

According to advice here: golang/go#58925, we
need to retract the old versions to have this page disappear. Given the
time that has passed since the 0.15.0 release I hope we can make this
change now.

Signed-off-by: Charlie Egan <charlie@styra.com>
@charlieegan3
Copy link
Author

Hi again, we've retracted the module now. I can see there's a message at the top of the page which is an improvement. However, it could still be confusing for a user since there's no link or redirect to the current module. Since the page also returns 200OK, I guess it's unlikely to be removed by search engines too.

Do we have any other options here?

@charlieegan3 charlieegan3 reopened this Mar 20, 2023
@bcmills
Copy link
Contributor

bcmills commented Mar 20, 2023

@charlieegan3, the comment from the retract directive is printed at the top of the page. If you start the retract message with the advice to use the updated module path, then it should be straightforward for folks to notice it.

Perhaps something like:

// Use the path github.com/open-policy-agent/opa (lower-case), not …/OPA.
// Before 0.15.0 OPA was not using go modules and the correct import path was not enforced.
retract [v0.1.0-rc1, v0.14.2]

@bcmills bcmills added WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided. and removed WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided. labels Mar 20, 2023
@charlieegan3
Copy link
Author

Ahh I see. We can change the message to include a link instead. Thanks again!

@charlieegan3 charlieegan3 mentioned this issue Mar 21, 2023
Merged
@golang golang locked and limited conversation to collaborators Mar 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge pkgsite/package-removal Issues for package removal. See https://pkg.go.dev/about#removing-a-package pkgsite WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
4 participants
@charlieegan3 @bcmills @gopherbot @seankhliao