kubernetes
/
kops
mirror of https://github.com/kubernetes/kops.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add a few docs comments on gomod and bazel

This commit is contained in:
mikesplain 2019-09-09 14:41:26 -04:00
parent 6d37885f39
commit c2d3367513
2 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/development/bazel.md
View File

@ -10,6 +10,9 @@ While bazel works well for small projects, building with kubernetes still has a
* We vendor our dependencies, rather than relying on gazelle (although actually gazelle works, the issue is when external dependencies like apimachinery include bazel files that confuse gazelle) * We vendor our dependencies, rather than relying on gazelle (although actually gazelle works, the issue is when external dependencies like apimachinery include bazel files that confuse gazelle)
* We strip bazel files from external dependencies, so we don't confuse gazelle * We strip bazel files from external dependencies, so we don't confuse gazelle
## Bazel versions:
For building kops release branches 1.14 and older, you may need to run an older version of bazel such as `0.24.0`. kops 1.15 and newer should be able to use more recent versions of bazel due to deprecation fixes that have not be backported.
## How to run ## How to run
``` ```

8
docs/development/vendoring.md
View File

@ -1,7 +1,9 @@
# Vendoring Go dependencies # Vendoring Go dependencies
kops uses [dep](https://github.com/golang/dep) to manage vendored kops uses [dep](https://github.com/golang/dep) to manage vendored
dependencies. dependencies in most versions leading up to kops 1.14.
kops uses [go mod](https://github.com/golang/go/wiki/Modules) to manage
vendored dependencies in versions 1.15 and newer.
## Prerequisites ## Prerequisites
@ -9,9 +11,11 @@ The following software must be installed prior to running the
update commands: update commands:
* [bazel](https://github.com/bazelbuild/bazel) * [bazel](https://github.com/bazelbuild/bazel)
* [dep](https://github.com/golang/dep) * [dep](https://github.com/golang/dep) or go >= v1.12 for go mod support
* [hg](https://www.mercurial-scm.org/wiki/Download) * [hg](https://www.mercurial-scm.org/wiki/Download)
<!-- TODO: update dependency management for go mod -->
## Adding a dependency to the vendor directory ## Adding a dependency to the vendor directory
The `dep` tool will manage required dependencies based on the imports The `dep` tool will manage required dependencies based on the imports