minikube/ADD_DEPENDENCY.md

37 lines
961 B
Markdown
Raw Normal View History

#### Adding a New Dependency
Minikube uses `Godep` to manage vendored dependencies.
`Godep` can be a bit finnicky with a project with this many dependencies.
Here is a rough set of steps that usually works to add a new dependency.
1. Make a clean GOPATH, with minikube in it.
2016-10-19 08:21:36 +00:00
This isn't strictly necessary, but it usually helps.
2016-10-19 08:21:36 +00:00
```shell
mkdir -p $HOME/newgopath/src/k8s.io
export GOPATH=$HOME/newgopath
cd $HOME/newgopath/src/k8s.io
git clone https://github.com/kubernetes/minikube.git
```
2016-10-19 08:21:36 +00:00
1. `go get` your new dependency.
```shell
go get mynewdepenency
```
2016-10-19 08:21:36 +00:00
1. Use it in code, build and test.
2016-10-19 08:21:36 +00:00
1. Import the dependency from GOPATH into vendor/
```shell
godep save ./...
```
2016-10-19 08:21:36 +00:00
If it is a large dependency, please commit the vendor/ directory changes separately.
This makes review easier in Github.
2016-10-19 08:21:36 +00:00
```shell
git add vendor/
git commit -m "Adding dependency foo"
git add --all
git commit -m "Adding cool feature"
```