Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

development.md#workflow should emphasize that local repo location is not optional #597

Closed
MikeSpreitzer opened this issue May 4, 2017 · 3 comments

Comments

@MikeSpreitzer
Copy link
Member

I used to be able to work on Kubernetes when its location on my laptop was $GOPATH/src/github.com/${my github profile name}/kubernetes (an obvious choice, IMO). Now that does not work. The location stated in https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#workflow --- namely $GOPATH/src/k8s.io/kubernetes --- is required . If that location is not used then the hack/update-bazel.sh script fails (e.g., see kubernetes/kubernetes#45263 (comment)). It would be good to update development.md#workflow to make it clear that the location it states MUST be used.

@MikeSpreitzer
Copy link
Member Author

It would also be good to have findable documentation for the hack/update-bazel.sh script; that could explain the requirement.

@xiangpengzhao
Copy link
Contributor

Mike, the documentation for bazel is here: https://github.com/kubernetes/community/blob/master/contributors/devel/bazel.md

And it explains the requirement:

Updating BUILD files

To update BUILD files, run:

$ ./hack/update-bazel.sh

NOTE: update-bazel.sh only works if check out directory of Kubernetes is $GOPATH/src/k8s.io/kubernetes.

@xiangpengzhao
Copy link
Contributor

I agree to make the documentation more findable. It would be great to put a new chapter introducing bazel briefly in development workflow.

/cc @bgrant0607

MikeSpreitzer added a commit to MikeSpreitzer/community that referenced this issue Jun 1, 2017
Emphasized that the local repo location is not optional.

Added a pointer to the page about building with Bazel.

Resolves kubernetes#597
MikeSpreitzer added a commit to MikeSpreitzer/community that referenced this issue Jun 1, 2017
Emphasized that the local repo location is not optional.

Added a pointer to the page about building with Bazel.

Resolves kubernetes#597
danehans pushed a commit to danehans/community that referenced this issue Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants