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

Canonical repo address is inconsistent with go import path #306

Closed
KateGo520 opened this issue Jul 28, 2020 · 6 comments
Closed

Canonical repo address is inconsistent with go import path #306

KateGo520 opened this issue Jul 28, 2020 · 6 comments
Labels
lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.

Comments

@KateGo520
Copy link

KateGo520 commented Jul 28, 2020

The github.com/directxman12/k8s-prometheus-adapter repo was just renamed to github.com/DirectXMan12/k8s-prometheus-adapter
This means that the canonical github repo address now conflicts with canonical go import packages (for example, "github.com/directxman12/k8s-prometheus-adapter/pkg/client", as referenced from https://github.com/DirectXMan12/k8s-prometheus-adapter/blob/v0.7.0/pkg/client/fake/client.go#L23)

It is now very easy for downstream consumers (which don't import "github.com/directxman12/k8s-prometheus-adapter/..." packages) to accidentally clone and add imports to upper-case "github.com/DirectXMan12/k8s-prometheus-adapter/..." packages. This will create many pitfalls and break the module users. They may encounter errors:

go get: github.com/DirectXMan12/[email protected]: parsing go.mod:
        module declares its path as: github.com/directxman12/k8s-prometheus-adapter
                but was required as: github.com/DirectXMan12/k8s-prometheus-adapter

(This was possible before, but way harder to do accidentally, since all the links and clone commands from github agreed with the canonical go import packages)

Cautionary tale:

Please consider reverting the directxman12 -> DirectXMan12 rename.

If the case change is here to stay, some things that would help a lot:

  1. Example go get github.com/directxman12/k8s-prometheus-adapter commands or others in the READMEs of all the go repos to guide consumers.
  2. Add canonical import paths with the correct case (https://golang.org/doc/go1.4#canonicalimports) to prevent accidental use of the wrong case downstream.
@KateGo520
Copy link
Author

@smarterclayton @sergii-koshel-exa Could you help me review this issue? Thx :p

@s-urbaniak
Copy link
Contributor

We are planning to move this repository into a more kubernetes canonical organization. Once this happens the issue should resolve itself.

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 30, 2021
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 1, 2021
@fejta-bot
Copy link

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/close

@k8s-ci-robot
Copy link
Contributor

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.
Projects
None yet
Development

No branches or pull requests

4 participants