forked from kubernetes-csi/csi-release-tools
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request kubernetes-csi#12 from pohly/release-tools
release tools
- Loading branch information
Showing
522 changed files
with
244 additions
and
399,534 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,11 @@ | ||
# See the OWNERS docs: https://git.k8s.io/community/contributors/guide/owners.md | ||
|
||
approvers: | ||
- saad-ali | ||
- jsafrane | ||
- msau42 | ||
- pohly | ||
- saad-ali | ||
- msau42 | ||
- pohly | ||
|
||
reviewers: | ||
- saad-ali | ||
- msau42 | ||
- pohly |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,51 @@ | ||
# csi-lib-utils | ||
|
||
TBD | ||
|
||
## Community, discussion, contribution, and support | ||
|
||
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/). | ||
|
||
You can reach the maintainers of this project at: | ||
|
||
- [Slack](http://slack.k8s.io/) | ||
- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-dev) | ||
|
||
### Code of conduct | ||
|
||
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md). | ||
|
||
[owners]: https://git.k8s.io/community/contributors/guide/owners.md | ||
[Creative Commons 4.0]: https://git.k8s.io/website/LICENSE | ||
# [csi-release-tools](https://github.com/kubernetes-csi/csi-release-tools) | ||
|
||
These build and test rules can be shared between different Go projects | ||
without modifications. Customization for the different projects happen | ||
in the top-level Makefile. | ||
|
||
The rules include support for building and pushing Docker images, with | ||
the following features: | ||
- one or more command and image per project | ||
- push canary and/or tagged release images | ||
- automatically derive the image tag(s) from repo tags | ||
- the source code revision is stored in a "revision" image label | ||
- never overwrites an existing release image | ||
|
||
Usage | ||
----- | ||
|
||
The expected repository layout is: | ||
- `cmd/*/*.go` - source code for each command | ||
- `cmd/*/Dockerfile` - docker file for each command or | ||
Dockerfile in the root when only building a single command | ||
- `Makefile` - includes `release-tools/build.make` and sets | ||
configuration variables | ||
- `.travis.yml` - a symlink to `release-tools/.travis.yml` | ||
|
||
To create a release, tag a certain revision with a name that | ||
starts with `v`, for example `v1.0.0`, then `make push` | ||
while that commit is checked out. | ||
|
||
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 | ||
`release-tools` 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 add --prefix=release-tools https://github.com/kubernetes-csi/csi-release-tools.git master` - add release tools to a repo which does not have them yet (only once) | ||
- `git subtree pull --prefix=release-tools https://github.com/kubernetes-csi/csi-release-tools.git master` - update local copy to latest upstream (whenever upstream changes) | ||
- edit, `git commit`, `git subtree push --prefix=release-tools git@github.com:<user>/csi-release-tools.git <my-new-or-existing-branch>` - push to a new branch before submitting a PR |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Release Process | ||
|
||
No tagged releases are planned at this point. The intention is to keep | ||
the master branch in a state such that it can be used for all | ||
supported branches in downstream repos which use these files. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,3 +11,4 @@ | |
# INSTRUCTIONS AT https://kubernetes.io/security/ | ||
|
||
saad-ali | ||
msau42 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
# Copyright 2019 The Kubernetes Authors. | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
.PHONY: build-% build container-% container push-% push clean test | ||
|
||
# A space-separated list of all commands in the repository, must be | ||
# set in main Makefile of a repository. | ||
# CMDS= | ||
|
||
# This is the default. It can be overridden in the main Makefile after | ||
# including build.make. | ||
REGISTRY_NAME=quay.io/k8scsi | ||
|
||
# Revision that gets built into each binary via the main.version | ||
# string. Uses the `git describe` output based on the most recent | ||
# version tag with a short revision suffix or, if nothing has been | ||
# tagged yet, just the revision. | ||
# | ||
# Beware that tags may also be missing in shallow clones as done by | ||
# some CI systems (like TravisCI, which pulls only 50 commits). | ||
REV=$(shell git describe --long --tags --match='v*' --dirty 2>/dev/null || git rev-list -n1 HEAD) | ||
|
||
# A space-separated list of image tags under which the current build is to be pushed. | ||
# Determined dynamically. | ||
IMAGE_TAGS= | ||
|
||
# A "canary" image gets built if the current commit is the head of the remote "master" branch. | ||
# That branch does not exist when building some other branch in TravisCI. | ||
IMAGE_TAGS+=$(shell if [ "$$(git rev-list -n1 HEAD)" = "$$(git rev-list -n1 origin/master 2>/dev/null)" ]; then echo "canary"; fi) | ||
|
||
# A "X.Y.Z-canary" image gets built if the current commit is the head of a "origin/release-X.Y.Z" branch. | ||
# The actual suffix does not matter, only the "release-" prefix is checked. | ||
IMAGE_TAGS+=$(shell git branch -r --points-at=HEAD | grep 'origin/release-' | grep -v -e ' -> ' | sed -e 's;.*/release-\(.*\);\1-canary;') | ||
|
||
# A release image "vX.Y.Z" gets built if there is a tag of that format for the current commit. | ||
# --abbrev=0 suppresses long format, only showing the closest tag. | ||
IMAGE_TAGS+=$(shell tagged="$$(git describe --tags --match='v*' --abbrev=0)"; if [ "$$tagged" ] && [ "$$(git rev-list -n1 HEAD)" = "$$(git rev-list -n1 $$tagged)" ]; then echo $$tagged; fi) | ||
|
||
# Images are named after the command contained in them. | ||
IMAGE_NAME=$(REGISTRY_NAME)/$* | ||
|
||
ifdef V | ||
# Adding "-alsologtostderr" assumes that all test binaries contain glog. This is not guaranteed. | ||
TESTARGS = -v -args -alsologtostderr -v 5 | ||
else | ||
TESTARGS = | ||
endif | ||
|
||
# Specific packages can be excluded from each of the tests below by setting the *_FILTER_CMD variables | ||
# to something like "| grep -v 'github.com/kubernetes-csi/project/pkg/foobar'". See usage below. | ||
|
||
build-%: | ||
mkdir -p bin | ||
CGO_ENABLED=0 GOOS=linux go build -a -ldflags '-X main.version=$(REV) -extldflags "-static"' -o ./bin/$* ./cmd/$* | ||
|
||
container-%: build-% | ||
docker build -t $*:latest -f $(shell if [ -e ./cmd/$*/Dockerfile ]; then echo ./cmd/$*/Dockerfile; else echo Dockerfile; fi) --label revision=$(REV) . | ||
|
||
push-%: container-% | ||
set -ex; \ | ||
push_image () { \ | ||
docker tag $*:latest $(IMAGE_NAME):$$tag; \ | ||
docker push $(IMAGE_NAME):$$tag; \ | ||
}; \ | ||
for tag in $(IMAGE_TAGS); do \ | ||
if [ "$$tag" = "canary" ] || echo "$$tag" | grep -q -e '-canary$$'; then \ | ||
: "creating or overwriting canary image"; \ | ||
push_image; \ | ||
elif docker pull $(IMAGE_NAME):$$tag 2>&1 | tee /dev/stderr | grep -q "manifest for $(IMAGE_NAME):$$tag not found"; then \ | ||
: "creating release image"; \ | ||
push_image; \ | ||
else \ | ||
: "release image $(IMAGE_NAME):$$tag already exists, skipping push"; \ | ||
fi; \ | ||
done | ||
|
||
build: $(CMDS:%=build-%) | ||
container: $(CMDS:%=container-%) | ||
push: $(CMDS:%=push-%) | ||
|
||
clean: | ||
-rm -rf bin | ||
|
||
test: | ||
|
||
.PHONY: test-go | ||
test: test-go | ||
test-go: | ||
@ echo; echo "### $@:" | ||
go test `go list ./... | grep -v 'vendor' $(TEST_GO_FILTER_CMD)` $(TESTARGS) | ||
|
||
.PHONY: test-vet | ||
test: test-vet | ||
test-vet: | ||
@ echo; echo "### $@:" | ||
go vet `go list ./... | grep -v vendor $(TEST_VET_FILTER_CMD)` | ||
|
||
.PHONY: test-fmt | ||
test: test-fmt | ||
test-fmt: | ||
@ echo; echo "### $@:" | ||
files=$$(find . -name '*.go' | grep -v './vendor' $(TEST_FMT_FILTER_CMD)); \ | ||
if [ $$(gofmt -d $$files | wc -l) -ne 0 ]; then \ | ||
echo "formatting errors:"; \ | ||
gofmt -d $$files; \ | ||
false; \ | ||
fi | ||
|
||
.PHONY: test-subtree | ||
test: test-subtree | ||
test-subtree: | ||
@ echo; echo "### $@:" | ||
./release-tools/verify-subtree.sh release-tools |
Oops, something went wrong.