github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-21 19:01:49 +00:00
Code Issues Projects Releases Wiki Activity

Update staging README to reflect multiple repos

Browse Source 
This directory no longer contains only client-go
This commit is contained in:
Lee Verberne 2017-05-08 14:00:22 -07:00
parent c92b818c92
commit 01c6f898bc
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
staging/README.md
View File

@ -1,15 +1,16 @@
This staging/src/k8s.io/client-go directory is the staging area of the client This directory is the staging area for packages that have been split to their
repo. It contains a versioned client, tools built around the client like the own repository. The content here will be periodically published to respective
reflector, and all the client dependencies. The content will be periodically top-level k8s.io repositories.
published to k8s.io/client-go repo.
The staged content is copied from the main repo, i.e., k8s.io/kubernetes, with Most code in the `staging/` directory is authoritative, i.e. the only copy of
directory rearrangement and necessary rewritings. To sync the content with the the code. You can directly modify such code. However the packages in
latest code in your local k8s.io/kubernetes, you need to run `godep restore` in `staging/src/k8s.io/client-go/pkg` are copied from `pkg/`. If you modify the
k8s root directory, then run hack/update-staging-client-go.sh. original code in `pkg/`, you need to run `hack/godep-restore.sh` from the k8s
root directory, followed by `hack/update-staging-client-go.sh`. We are working
towards making all code in `staging/` authoritative.
vendor/k8s.io/client-go is a symlink pointing to this staging area, so to use The `vendor/k8s.io` directory contains symlinks pointing to this staging area,
the packages in the staging area, you can import it as so to use a package in the staging area, you can import it as
"vendor/client-go/<package-name>", as if the client were vendored. The client `k8s.io/<package-name>`, as if the package were vendored. Packages will be
will be vendored from k8s.io/client-go for real after the test matrix is vendored from `k8s.io/<package-name>` for real after the test matrix is
converted to vendor k8s components. converted to vendor k8s components.