github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-23 18:40:53 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #4276 from a-robinson/docs

Browse Source 
Add steps to the development guide for how to use godep to update an existing dependency
This commit is contained in:
roberthbailey 2015-02-10 10:11:57 -08:00
commit 2c2a59568c
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/devel/development.md
View File

@ -31,17 +31,18 @@ Kubernetes uses [godep](https://github.com/tools/godep) to manage dependencies.
### Installing godep ### Installing godep
There are many ways to build and host go binaries. Here is an easy way to get utilities like ```godep``` installed: There are many ways to build and host go binaries. Here is an easy way to get utilities like ```godep``` installed:
1. Ensure that [mercurial](http://mercurial.selenic.com/wiki/Download) is installed on your system. (some of godep's dependencies use the mercurial 1) Ensure that [mercurial](http://mercurial.selenic.com/wiki/Download) is installed on your system. (some of godep's dependencies use the mercurial
source control system). Use ```apt-get install mercurial``` or ```yum install mercurial``` on Linux, or [brew.sh](http://brew.sh) on OS X, or download source control system). Use ```apt-get install mercurial``` or ```yum install mercurial``` on Linux, or [brew.sh](http://brew.sh) on OS X, or download
directly from mercurial. directly from mercurial.
2. Create a new GOPATH for your tools and install godep:
2) Create a new GOPATH for your tools and install godep:
``` ```
export GOPATH=$HOME/go-tools export GOPATH=$HOME/go-tools
mkdir -p $GOPATH mkdir -p $GOPATH
go get github.com/tools/godep go get github.com/tools/godep
``` ```
3. Add $GOPATH/bin to your path. Typically you'd add this to your ~/.profile: 3) Add $GOPATH/bin to your path. Typically you'd add this to your ~/.profile:
``` ```
export GOPATH=$HOME/go-tools export GOPATH=$HOME/go-tools
export PATH=$PATH:$GOPATH/bin export PATH=$PATH:$GOPATH/bin
@ -50,8 +51,7 @@ export PATH=$PATH:$GOPATH/bin
### Using godep ### Using godep
Here is a quick summary of `godep`. `godep` helps manage third party dependencies by copying known versions into Godeps/_workspace. Here is the recommended way to set up your system. There are other ways that may work, but this is the easiest one I know of. Here is a quick summary of `godep`. `godep` helps manage third party dependencies by copying known versions into Godeps/_workspace. Here is the recommended way to set up your system. There are other ways that may work, but this is the easiest one I know of.
1. Devote a directory to this endeavor: 1) Devote a directory to this endeavor:
``` ```
export KPATH=$HOME/code/kubernetes export KPATH=$HOME/code/kubernetes
mkdir -p $KPATH/src/github.com/GoogleCloudPlatform/kubernetes mkdir -p $KPATH/src/github.com/GoogleCloudPlatform/kubernetes
@ -60,8 +60,7 @@ git clone https://path/to/your/fork .
# Or copy your existing local repo here. IMPORTANT: making a symlink doesn't work. # Or copy your existing local repo here. IMPORTANT: making a symlink doesn't work.
``` ```
2. Set up your GOPATH. 2) Set up your GOPATH.
``` ```
# Option A: this will let your builds see packages that exist elsewhere on your system. # Option A: this will let your builds see packages that exist elsewhere on your system.
export GOPATH=$KPATH:$GOPATH export GOPATH=$KPATH:$GOPATH
@ -70,24 +69,27 @@ export GOPATH=$KPATH
# Option B is recommended if you're going to mess with the dependencies. # Option B is recommended if you're going to mess with the dependencies.
``` ```
3. Populate your new $GOPATH. 3) Populate your new $GOPATH.
``` ```
cd $KPATH/src/github.com/GoogleCloudPlatform/kubernetes cd $KPATH/src/github.com/GoogleCloudPlatform/kubernetes
godep restore godep restore
``` ```
4. To add a dependency, you can do ```go get path/to/dependency``` as usual. 4) Next, you can either add a new dependency or update an existing one.
5. To package up a dependency, do
``` ```
# To add a new dependency, run:
cd $KPATH/src/github.com/GoogleCloudPlatform/kubernetes cd $KPATH/src/github.com/GoogleCloudPlatform/kubernetes
go get path/to/dependency
godep save ./... godep save ./...
# Sanity check that your Godeps.json file is ok by re-restoring:
godep restore # To update an existing dependency, do
cd $KPATH/src/github.com/GoogleCloudPlatform/kubernetes
go get -u 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```
I (lavalamp) have sometimes found it expedient to manually fix the /Godeps/godeps.json file to minimize the changes. I (lavalamp) have sometimes found it expedient to manually fix the /Godeps/godeps.json file to minimize the changes.
Please send dependency updates in separate commits within your PR, for easier reviewing. Please send dependency updates in separate commits within your PR, for easier reviewing.