INSTALL.md: update Glide instructions to prefer glide update #127
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
This change is |
INSTALL.md
Outdated
| version: v2.0.0 | ||
| ``` | ||
|
|
||
| Second, add a Go file that imports `client-go` somewhere in your project (Glide |
There was a problem hiding this comment.
I tried it locally. Glide still added client-go to vendor/, but it didn't parse client-go/godeps.json, so all client-go's dependencies were missed in vendor/. So how about this:
Second, add a Go file that imports client-go somewhere in your project, otherwise client-go's dependencies will not be added to your procject's vendor/.
There was a problem hiding this comment.
updated, thanks!
ericchiang
force-pushed
the
glide-instructions
branch
from
1902a1e
to
1ee8599
Compare
INSTALL.md
Outdated
| glide up -v | ||
| ``` | ||
|
|
||
| Importantly, Glide will detect the versions of dependencies `client-go` |
There was a problem hiding this comment.
Could you describe the directory layout after the second step is done? Maybe something like this:
At this point, k8s.io/client-go should be added to your project's vendor/. client-go's dependencies should be flattened and be added to your project's vendor/ as well.
Glide will detect the versions of dependencies client-go specified in client-go's Godep.json file, and automatically set the versions of these imports in your /vendor directory. It will also record the detected version of all dependencies in the glide.lock file.
INSTALL.md
Outdated
| ``` | ||
|
|
||
| Importantly, Glide will detect the versions of dependencies `client-go` | ||
| specifies in its `Godep.json` file, and automatically set the versions of these |
INSTALL.md
Outdated
| imports in your /vendor directory. It will also record the detected version of | ||
| all dependencies in the `glide.lock` file. | ||
|
|
||
| Glide will prefer package versions specified in `glide.yaml` over versions |
There was a problem hiding this comment.
Could you make it clear that the setup is done after step 2, and this paragraph is optional, only useful if the user wants to overwrite the version of the dep?
|
Left a couple more comments. Thanks for the pull! FYI @lavalamp |
`glide get` has weird dependencies on the glide cache. `glide install` just updates `glide.lock` but doesn't update /vendor. `glide init` will detect dependencies from your current project, making it dependent on the external files. Just recommend users create a `glide.yaml` manually, then use `glide update` to populate their /vendor directory. Technically you could do a dance of `glide init` -> `glide get` -> `glide update`[0] but this seems less error prone. Additionally, provide instructions for users who want to use different versions of packages than `client-go`, and add a note about glide-vc. [0] https://github.com/coreos/etcd/blob/v3.1.1/scripts/updatedep.sh
ericchiang
force-pushed
the
glide-instructions
branch
from
1ee8599
to
416948d
Compare
| imports in your /vendor directory. It will also record the detected version of | ||
| all dependencies in the `glide.lock` file. | ||
|
|
||
| Projects that require a different version of a dependency than `client-go` |
There was a problem hiding this comment.
@caesarxuchao this work?
|
Fix #122. |
|
lgtm. @ash2k @lvangool @jaxxstorm @lavalamp it would be great if you can try the new guide in your environment :) |
|
@caesarxuchao confirmed new guide is working. LGTM! |
|
Cool. Merging. Thank you all. |
glide gethas weird dependencies on the glide cache.glide installjust updatesglide.lockbut doesn't update /vendor.glide initwill detect dependencies from your current project,making it dependent on the external files.
Just recommend users create a
glide.yamlmanually, then useglide updateto populate their /vendor directory. Technically youcould do a dance of
glide init->glide get->glide update[0]but this seems less error prone.
Additionally, provide instructions for users who want to use
different versions of packages than
client-go, and add a noteabout glide-vc.
[0] https://github.com/coreos/etcd/blob/v3.1.1/scripts/updatedep.sh
Sorry, client-go does not accept changes via pull requests at this time. Please
submit your pull request to the main repository:
https://github.com/kubernetes/kubernetes. See the guidance here:
https://github.com/kubernetes/client-go#contributing-code.
cc @caesarxuchao @lavalamp @kubernetes/client-go-reviewers