github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-23 11:50:44 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #47282 from pmorie/staging-infos

Browse Source 
Automatic merge from submit-queue

Add information about staging repos to README

Pretty much what it sounds like.
This commit is contained in:
Kubernetes Submit Queue 2017-08-04 16:22:49 -07:00 committed by GitHub
commit cdb7a2bbf2
1 changed files with 35 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
staging/README.md
View File

@ -1,12 +1,40 @@
# External Repository Staging Area
This directory is the staging area for packages that have been split to their This directory is the staging area for packages that have been split to their
own repository. The content here will be periodically published to respective own repository. The content here will be periodically published to respective
top-level k8s.io repositories. top-level k8s.io repositories.
The code in the `staging/` directory is authoritative, i.e. the only copy of Repositories currently staged here:
the code. You can directly modify such code.
The `vendor/k8s.io` directory contains symlinks pointing to this staging area, - [`k8s.io/apiextensions-apiserver`](https://github.com/kubernetes/apiextensions-apiserver)
so to use a package in the staging area, you can import it as - [`k8s.io/api`](https://github.com/kubernetes/api)
`k8s.io/<package-name>`, as if the package were vendored. Packages will be - [`k8s.io/apimachinery`](https://github.com/kubernetes/apimachinery)
vendored from `k8s.io/<package-name>` for real after the test matrix is - [`k8s.io/apiserver`](https://github.com/kubernetes/apiserver)
converted to vendor k8s components. - [`k8s.io/client-go`](https://github.com/kubernetes/client-go)
- [`k8s.io/kube-aggregator`](https://github.com/kubernetes/kube-aggregator)
- [`k8s.io/kube-gen`](https://github.com/kubernetes/kube-gen) (about to be published)
- [`k8s.io/metrics`](https://github.com/kubernetes/metrics)
- [`k8s.io/sample-apiserver`](https://github.com/kubernetes/sample-apiserver)
The code in the staging/ directory is authoritative, i.e. the only copy of the
code. You can directly modify such code.
## Using staged repositories from Kubernetes code
Kubernetes code uses the repositories in this directory via symlinks in the
`vendor/k8s.io` directory into this staging area. For example, when
Kubernetes code imports a package from the `k8s.io/client-go` repository, that
import is resolved to `staging/src/k8s.io/client-go` relative to the project
root:
```go
// pkg/example/some_code.go
package example
import (
"k8s.io/client-go/dynamic" // resolves to staging/src/k8s.io/client-go/dynamic
)
```
Once the change-over to external repositories is complete, these repositories
will actually be vendored from `k8s.io/<package-name>`.