diff --git a/README.md b/README.md index b5b24b217857..a682a207ccd2 100644 --- a/README.md +++ b/README.md @@ -118,6 +118,10 @@ test jobs for a variety of platforms (e.g., Azure, rktnetes). The test-history scripts gather e2e results from these federated jobs. For information about how to contribute test results, see [Federated Testing](docs/federated_testing.md). +## Other Docs + +* [kubernetes/test-infra dependency management](docs/dep.md) + [`jobs/config.json`]: https://github.com/kubernetes/test-infra/blob/master/jobs/config.json [`prow/config.yaml`]: https://github.com/kubernetes/test-infra/blob/master/prow/config.yaml diff --git a/docs/dep.md b/docs/dep.md new file mode 100644 index 000000000000..70a0f12244e8 --- /dev/null +++ b/docs/dep.md @@ -0,0 +1,26 @@ +# kubernetes/test-infra dependency management + +test-infra uses [`dep`](https://github.com/golang/dep) for Go dependency +management. `dep` is a prototype dependency management tool for Go. It requires +Go 1.8 or newer to compile. + + +## Setup + +You can follow the [setup instructions](https://github.com/golang/dep#setup) to +set up `dep` in your local environment. + + +## Changing dependencies + +You can use the `dep` instructions for [adding](https://github.com/golang/dep#adding-a-dependency), +[updating](https://github.com/golang/dep#updating-dependencies) or +[removing](https://github.com/golang/dep#removing-dependencies) a dependency. + +Once you've updated, make sure to run: +``` +dep prune +verify/update-bazel.sh +``` + +To prune unneeded deps, and then update all the bazel files that `dep` blows away.