Skip to content

Commit

Permalink
Add basic docs for using dep
Browse files Browse the repository at this point in the history
  • Loading branch information
cblecker committed Nov 2, 2017
1 parent a4c8fbf commit 6bf1aa7
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 26 additions & 0 deletions docs/dep.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 6bf1aa7

Please sign in to comment.