From ac8dc5ecc993da7bac2578ca43fecb856a4c664c Mon Sep 17 00:00:00 2001 From: Andy Goldstein Date: Fri, 18 Aug 2017 14:26:02 -0400 Subject: [PATCH] Doc dep mgmt Signed-off-by: Andy Goldstein --- docs/build-from-scratch.md | 6 ++++++ docs/vendoring-dependencies.md | 23 +++++++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 docs/vendoring-dependencies.md diff --git a/docs/build-from-scratch.md b/docs/build-from-scratch.md index 338fdbe24..df2ea33c6 100644 --- a/docs/build-from-scratch.md +++ b/docs/build-from-scratch.md @@ -6,6 +6,7 @@ While the [README][0] pulls from the Heptio image registry, you can also build y * [1. Download][2] * [2. Build][3] * [3. Run][7] +* [4. Vendoring dependencies][10] ## 0. Prerequisites @@ -57,6 +58,9 @@ kubectl set image deployment/ark ark=$REGISTRY/$PROJECT:$VERSION ``` where `$REGISTRY`, `$PROJECT`, and `$VERSION` match what you used in the [build step][3]. +## 4. Vendoring dependencies +If you need to add or update the vendored dependencies, please see [Vendoring dependencies][11]. + [0]: ../README.md [1]: #0-prerequisites [2]: #1-download @@ -67,3 +71,5 @@ where `$REGISTRY`, `$PROJECT`, and `$VERSION` match what you used in the [build [7]: #3-run [8]: reference.md#ark-config-definition [9]: cloud-provider-specifics.md +[10]: #4-vendoring-dependencies +[11]: vendoring-dependencies.md diff --git a/docs/vendoring-dependencies.md b/docs/vendoring-dependencies.md new file mode 100644 index 000000000..ce5f9a9d4 --- /dev/null +++ b/docs/vendoring-dependencies.md @@ -0,0 +1,23 @@ +# Vendoring dependencies + +## Overview + +We are using [dep][0] to manage dependencies. You can install it by running + +``` +go get -u github.com/golang/dep/cmd/dep +``` + +Dep currently pulls in a bit more than we'd like, so +we have created a script to remove these extra files: `hack/dep-save.sh`. + +## Adding a new dependency + +Run `hack/dep-save.sh`. If you want to see verbose output, you can append `-v` as in +`hack/dep-save.sh -v`. + +## Updating an existing dependency + +Run `hack/dep-save.sh -update [ ...]` to update one or more dependencies. + +[0]: https://github.com/golang/dep