From 6278096d53971cf99df455b94171364afb25efdd Mon Sep 17 00:00:00 2001 From: austin Date: Fri, 11 May 2018 09:03:36 -0700 Subject: Adds WHAT env variable description When contributing specific parts of k8s, its helpful to know how to slice the build to only build a certain binary. --- contributors/guide/github-workflow.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'contributors/guide/github-workflow.md') diff --git a/contributors/guide/github-workflow.md b/contributors/guide/github-workflow.md index a1429258..ac747abc 100644 --- a/contributors/guide/github-workflow.md +++ b/contributors/guide/github-workflow.md @@ -74,6 +74,22 @@ git checkout -b myfeature Then edit code on the `myfeature` branch. #### Build +The following section is a quick start on how to build Kubernetes locally, for more detailed information you can see [kubernetes/build](https://git.k8s.io/kubernetes/build/README.md). +The best way to validate your current setup is to build a small part of Kubernetes. This way you can address issues without waiting for the full build to complete. To build a specific part of Kubernetes use the `WHAT` environment variable to let the build scripts know you want to build only a certain package/executable. + +```sh +make WHAT=cmd/{$package_you_want} +``` + +*Note:* This applies to all top level folders under kubernetes/cmd. + +So for the cli, you can run: + +```sh +make WHAT=cmd/kubectl +``` + +If everything checks out you will have an executable in the `_output/bin` directory to play around with. *Note:* If you are using `CDPATH`, you must either start it with a leading colon, or unset the variable. The make rules and scripts to build require the current directory to come first on the CD search path in order to properly navigate between directories. -- cgit v1.2.3