summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhillip Wittrock <pwittroc@google.com>2015-08-26 17:22:27 -0700
committerPhillip Wittrock <pwittroc@google.com>2015-08-26 17:35:36 -0700
commitd2d04300c597902f646e846bbdb762080b6b7eba (patch)
treed23cbd5591f24d8ab13953a430acbeda747f73f4
parent9f072bfee1680519bd871b679ad344ac07515831 (diff)
Update development godep instructions to work for cadvisor and changing transitive deps
-rw-r--r--development.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/development.md b/development.md
index a266f7cb..fc1de093 100644
--- a/development.md
+++ b/development.md
@@ -145,6 +145,8 @@ Here's a quick walkthrough of one way to use godeps to add or update a Kubernete
1) Devote a directory to this endeavor:
+_Devoting a separate directory is not required, but it is helpful to separate dependency updates from other changes._
+
```sh
export KPATH=$HOME/code/kubernetes
mkdir -p $KPATH/src/k8s.io/kubernetes
@@ -183,10 +185,17 @@ godep save ./...
cd $KPATH/src/k8s.io/kubernetes
go get -u path/to/dependency
# Change code in Kubernetes accordingly if necessary.
-godep update path/to/dependency
+godep update path/to/dependency/...
```
-5) Before sending your PR, it's a good idea to sanity check that your Godeps.json file is ok by re-restoring: `godep restore`
+_If `go get -u path/to/dependency` fails with compilation errors, instead try `go get -d -u path/to/dependency`
+to fetch the dependencies without compiling them. This can happen when updating the cadvisor dependency._
+
+
+5) Before sending your PR, it's a good idea to sanity check that your Godeps.json file is ok by running hack/verify-godeps.sh
+
+_If hack/verify-godeps.sh fails after a `godep update`, it is possible that a transitive dependency was added or removed but not
+updated by godeps. It then may be necessary to perform a `godep save ./...` to pick up the transitive dependency changes._
It is sometimes expedient to manually fix the /Godeps/godeps.json file to minimize the changes.