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

Document that client-go is not yet compatible with dep #319

Merged
merged 1 commit into from
Nov 1, 2017

Conversation

caesarxuchao
Copy link
Member

@caesarxuchao caesarxuchao commented Oct 31, 2017

@sttts could you proof read this? Thank you.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 31, 2017
@k8s-reviewable
Copy link

This change is Reviewable

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 31, 2017
@caesarxuchao
Copy link
Member Author

cc @rickypai @danderson

INSTALL.md Outdated
However, client-go does not work well with `dep` yet. To support `dep`, we need
to fix at least two issues:
1. publish native `Gopkg.toml` in client-go and other k8s.io repos, like `k8s.io/apimachinery`;
2. find a way to express transitive constraints (see https://github.com/golang/dep/issues/1124).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I would add: If you use dep today, you have to specify client-go dependencies manually in Gopkg.toml.

The client-go vendoring reality looks like this: https://twitter.com/the_sttts/status/924931147003547648. So many people use dep (more or less successfully, more or less due to luck that the master branches of our dependencies happen to work with our code today).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

INSTALL.md Outdated

To use `dep` with client-go safely today, you have to specify client-go
dependencies manually in Gopkg.toml with the versions listed in
[Godeps.json](./Godeps/Godeps.json).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably repeat that this is not yet supported. We should also set expectations as to the cost of migrating from the work around to the final solution.


As a workaround, which may or may not be worthwhile, you can specify all
client-go dependencies manually as
[override](https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md#override)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sttts is this accurate?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

@sttts
Copy link
Contributor

sttts commented Nov 1, 2017

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 1, 2017
@caesarxuchao caesarxuchao merged commit 72e1c2a into kubernetes:master Nov 1, 2017
@caesarxuchao
Copy link
Member Author

Thank you both for the review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants