diff options
| author | Mike Danese <mikedanese@google.com> | 2016-10-19 18:32:33 -0700 |
|---|---|---|
| committer | Mike Danese <mikedanese@google.com> | 2016-10-21 17:32:33 -0700 |
| commit | e7c5a242ee56f2bc2b8e2ba9ea03bc8ed618a432 (patch) | |
| tree | b83ee27bd51260f02c2e96831249550b140afd52 | |
| parent | 2e7b09eaa8c743e907be96f5755fae9ac0c1951f (diff) | |
add some docs about building with bazel
| -rw-r--r-- | bazel.md | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/bazel.md b/bazel.md new file mode 100644 index 00000000..2c321a90 --- /dev/null +++ b/bazel.md @@ -0,0 +1,72 @@ +<!-- BEGIN MUNGE: UNVERSIONED_WARNING --> + +<!-- BEGIN STRIP_FOR_RELEASE --> + +<img src="http://kubernetes.io/kubernetes/img/warning.png" alt="WARNING" + width="25" height="25"> +<img src="http://kubernetes.io/kubernetes/img/warning.png" alt="WARNING" + width="25" height="25"> +<img src="http://kubernetes.io/kubernetes/img/warning.png" alt="WARNING" + width="25" height="25"> +<img src="http://kubernetes.io/kubernetes/img/warning.png" alt="WARNING" + width="25" height="25"> +<img src="http://kubernetes.io/kubernetes/img/warning.png" alt="WARNING" + width="25" height="25"> + +<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2> + +If you are using a released version of Kubernetes, you should +refer to the docs that go with that version. + +Documentation for other releases can be found at +[releases.k8s.io](http://releases.k8s.io). +</strong> +-- + +<!-- END STRIP_FOR_RELEASE --> + +<!-- END MUNGE: UNVERSIONED_WARNING --> + +# Build with Bazel + +Building with bazel is currently experimental. Automanaged BUILD rules have the +tag "automanaged" and are maintained by +[gazel](https://github.com/mikedanese/gazel). Instructions for installing bazel +can be found [here](https://www.bazel.io/versions/master/docs/install.html). + +To build docker images for the components, run: + +``` +$ bazel build //build/... +``` + +To run many of the unit tests, run: + +``` +$ bazel test //cmd/... //build/... //pkg/... //federation/... //plugin/... +``` + +To update automanaged build files, run: + +``` +$ ./hack/update-bazel.sh +``` + + +To update a single build file, run: + +``` +$ # get gazel +$ go get -u github.com/mikedanese/gazel +$ # .e.g. ./pkg/kubectl/BUILD +$ gazel ./pkg/kubectl +``` + +Updating BUILD file for a package will be required when: +* Files are added to or removed from a package +* Import dependencies change for a package + + +<!-- BEGIN MUNGE: GENERATED_ANALYTICS --> +[]() +<!-- END MUNGE: GENERATED_ANALYTICS --> |