Commit b41cac35 by Aaron Crickenberger

Add files from github.com/pohly/csi-build-rules

parent 0535c0d4
# Kubernetes Template Project # [csi-build-rules](https://github.com/kubernetes-csi/csi-build-rules)
The Kubernetes Template Project is a template for starting new projects in the GitHub organizations owned by Kubernetes. All Kubernetes projects, at minimum, must have the following files: These build and test rules can be shared between different Go projects
without modifications. Customization for the different projects happen
- a `README.md` outlining the project goals, sponsoring sig, and community contact information in the top-level Makefile.
- an `OWNERS` with the project leads listed as approvers ([docs on `OWNERS` files][owners])
- a `CONTRIBUTING.md` outlining how to contribute to the project The rules include support for building and pushing Docker images, with
- an unmodified copy of `code-of-conduct.md` from this repo, which outlines community behavior and the consequences of breaking the code the following features:
- a `LICENSE` which must be Apache 2.0 for code projects, or [Creative Commons 4.0] for documentation repositories, without any custom content - one or more command and image per project
- a `SECURITY_CONTACTS` with the contact points for the Product Security Team - push canary and/or tagged release images
to reach out to for triaging and handling of incoming issues. They must agree to abide by the - automatically derive the image tag(s) from repo tags
[Embargo Policy](https://github.com/kubernetes/sig-release/blob/master/security-release-process-documentation/security-release-process.md#embargo-policy) - the source code revision is stored in a "revision" image label
and will be removed and replaced if they violate that agreement. - never overwrites an existing release image
## Community, discussion, contribution, and support Usage
-----
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
The expected repository layout is:
You can reach the maintainers of this project at: - `cmd/*/*.go` - source code for each command
- `cmd/*/Dockerfile` - docker file for each command or
- [Slack](http://slack.k8s.io/) Dockerfile in the root when only building a single command
- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-dev) - `Makefile` - includes `build-rules/build.make` and sets
configuration variables
### Code of conduct - `.travis.yml` - a symlink to `build-rules/.travis.yml`
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md). To create a release, tag a certain revision with a name that
starts with `v`, for example `v1.0.0`, then `make push`
[owners]: https://git.k8s.io/community/contributors/guide/owners.md while that commit is checked out.
[Creative Commons 4.0]: https://git.k8s.io/website/LICENSE
It does not matter on which branch that revision exists, i.e. it is
possible to create releases directly from master. A release branch can
still be created for maintenance releases later if needed.
Release branches are expected to be named `release-x.y` for releases
`x.y.z`. Building from such a branch creates `x.y-canary`
images. Building from master creates the main `canary` image.
Sharing and updating
--------------------
[`git subtree`](https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt)
is the recommended way of maintaining a copy of the rules inside the
`build-rules` directory of a project. This way, it is possible to make
changes also locally, test them and then push them back to the shared
repository at a later time.
Cheat sheet:
- `git subtree pull --prefix=build-rules https://github.com/kubernetes-csi/csi-build-rules.git master` - update local copy to latest upstream
- edit, `git commit`, `git subtree push --prefix=build-rules git@github.com:<user>/csi-build-rules.git <my-new-or-existing-branch>` - push to a new branch before submitting a PR
This diff is collapsed. Click to expand it.
language: go
sudo: required
services:
- docker
matrix:
include:
- go: 1.11.1
script:
- make all test
after_success:
- if [ "${TRAVIS_PULL_REQUEST}" == "false" ]; then
docker login -u "${DOCKER_USERNAME}" -p "${DOCKER_PASSWORD}" quay.io;
make push;
fi
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment