github/client-go
1
0
Fork 0
mirror of https://github.com/kubernetes/client-go.git synced 2025-07-18 01:01:05 +00:00
Code Issues Projects Releases Wiki Activity

INSTALL.md: update Glide instructions to prefer glide update

Browse Source 
`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
This commit is contained in:
Eric Chiang 2017-02-22 09:59:45 -08:00
parent 82a657e390
commit 416948da08
1 changed files with 52 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
INSTALL.md
View File

@ -107,30 +107,60 @@ then `rm -rf vendor/` to remove `client-go`'s copy of its dependencies.
### Glide ### Glide
[glide](https://github.com/Masterminds/glide) is another popular dependency [Glide](https://github.com/Masterminds/glide) is another popular dependency
management tool for go. Glide will manage your /vendor directory, but unlike management tool for Go. Glide will manage your /vendor directory, but unlike
godep, will not modify your $GOPATH (there's no equivalent of `godep restore` or godep, will not use or modify your $GOPATH (there's no equivalent of
`godep save`). To get the `client-go` dependency list into glide's format, you `godep restore` or `godep save`).
can run this series of commands:
```sh Generally, it's best to avoid Glide's many subcommands, favoring modifying
go get k8s.io/client-go Glide's manifest file (`glide.yaml`) directly, then running
cd $GOPATH/src/k8s.io/client-go `glide update --strip-vendor`. First create a `glide.yaml` file at the root of
git checkout v2.0.0 your project:
# cd 1.5 # only necessary with 1.5 and 1.4 clients.
glide init # Will import from godep format and produce glide.yaml ```yaml
package: ( your project's import path ) # e.g. github.com/foo/bar
import:
- package: k8s.io/client-go
version: v2.0.0
``` ```
Next there are two possibilities: you could copy the `glide.yaml` file into your Second, add a Go file that imports `client-go` somewhere in your project,
own project (change the `project: ` line at the top!), or, if you already have a otherwise `client-go`'s dependencies will not be added to your project's
`glide.yaml` file, you'll need to merge this `glide.yaml` with it. vendor/. Then run the following command in the same directory as `glide.yaml`:
At this point, your `glide.yaml` file has all the dependencies of the client ```sh
library, but doesn't list the client itself. Running `glide get glide update --strip-vendor
--strip-vendor k8s.io/client-go#^2.0.0` will add `client-go` to the dependency ```
list, and all the dependencies should resolve correctly.
Note that simply running `glide get k8s.io/client-go#^2.0.0` without first This can also be abbreviated as:
getting the dependencies sorted out doesn't seem to trigger glide's
import-from-godep code, and as a consequence it doesn't resolve the dependencies ```sh
correctly. glide up -v
```
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.
Projects that require a different version of a dependency than `client-go`
requests can override the version manually in `glide.yaml`. For example:
```yaml
package: ( your project's import path ) # e.g. github.com/foo/bar
import:
- package: k8s.io/client-go
version: v2.0.0
# Use a newer version of go-spew even though client-go wants an old one.
- package: github.com/davecgh/go-spew
version: v1.1.0
```
After modifying, run `glide up -v` again to re-populate your /vendor directory.
Optionally, Glide users can also use [`glide-vc`](https://github.com/sgotti/glide-vc)
after running `glide up -v` to remove unused files from /vendor.