Release for v0.5.1

.gitignore

@@ -19,3 +19,6 @@
 
 # Vscode files
 .vscode
+
+# Tools binaries.
+hack/tools/bin

.golangci.yml

@@ -1,5 +1,28 @@
+linters:
+  disable-all: true
+  enable:
+    - misspell
+    - structcheck
+    - golint
+    - govet
+    - deadcode
+    - errcheck
+    - varcheck
+    - goconst
+    - unparam
+    - ineffassign
+    - nakedret
+    - interfacer
+    - gocyclo
+    - lll
+    - dupl
+    - goimports
+
 linters-settings:
   lll:
     line-length: 170
   dupl:
     threshold: 400
+
+run:
+  timeout: 5m

Makefile

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-#  Copyright 2019 The Kubernetes Authors.
+#  Copyright 2020 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.
@@ -14,11 +14,30 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-#
-# Makefile with some common workflow for dev, build and test
-#
+# If you update this file, please follow
+# https://suva.sh/posts/well-documented-makefiles
+
+## --------------------------------------
+## General
+## --------------------------------------
+
+SHELL:=/usr/bin/env bash
+.DEFAULT_GOAL:=help
 
-##@ General
+# Use GOPROXY environment variable if set
+GOPROXY := $(shell go env GOPROXY)
+ifeq ($(GOPROXY),)
+GOPROXY := https://proxy.golang.org
+endif
+export GOPROXY
+
+# Active module mode, as we use go modules to manage dependencies
+export GO111MODULE=on
+
+# Tools.
+TOOLS_DIR := hack/tools
+TOOLS_BIN_DIR := $(TOOLS_DIR)/bin
+GOLANGCI_LINT := $(abspath $(TOOLS_BIN_DIR)/golangci-lint)
 
 # The help will print out all targets with their descriptions organized bellow their categories. The categories are represented by `##@` and the target descriptions by `##`.
 # The awk commands is responsible to read the entire set of makefiles included in this invocation, looking for lines of the file as xyz: ## something, and then pretty-format the target and help. Then, if there's a line with ##@ something, that gets pretty-printed as a category.
@@ -28,9 +47,52 @@
 help:  ## Display this help
 	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
-##@ Tests
+## --------------------------------------
+## Testing
+## --------------------------------------
 
 .PHONY: test
-test: ## Run the script check-everything.sh which will check all
-	GO111MODULE=on TRACE=1 ./hack/check-everything.sh
+test: ## Run the script check-everything.sh which will check all.
+	TRACE=1 ./hack/check-everything.sh
+
+## --------------------------------------
+## Binaries
+## --------------------------------------
+
+$(GOLANGCI_LINT): $(TOOLS_DIR)/go.mod # Build golangci-lint from tools folder.
+	cd $(TOOLS_DIR); go build -tags=tools -o bin/golangci-lint github.com/golangci/golangci-lint/cmd/golangci-lint
+
+## --------------------------------------
+## Linting
+## --------------------------------------
+
+.PHONY: lint
+lint: $(GOLANGCI_LINT) ## Lint codebase.
+	$(GOLANGCI_LINT) run -v
+
+## --------------------------------------
+## Generate
+## --------------------------------------
+
+.PHONY: modules
+modules: ## Runs go mod to ensure modules are up to date.
+	go mod tidy
+	cd $(TOOLS_DIR); go mod tidy
+
+## --------------------------------------
+## Cleanup / Verification
+## --------------------------------------
+
+.PHONY: clean
+clean: ## Cleanup.
+	$(MAKE) clean-bin
+
+.PHONY: clean-bin
+clean-bin: ## Remove all generated binaries.
+	rm -rf hack/tools/bin
 
+.PHONY: verify-modules
+verify-modules: modules
+	@if !(git diff --quiet HEAD -- go.sum go.mod); then \
+		echo "go module files are out of date"; exit 1; \
+	fi

OWNERS

@@ -2,6 +2,7 @@
 
 approvers:
   - controller-runtime-admins
+  - controller-runtime-maintainers
   - controller-runtime-approvers
 reviewers:
   - controller-runtime-admins

OWNERS_ALIASES

@@ -8,16 +8,20 @@ aliases:
   - droot
   - mengqiy
 
+  # non-admin folks who have write-access and can approve any PRs in the repo
+  controller-runtime-maintainers:
+  - vincepri
+
   # non-admin folks who can approve any PRs in the repo
   controller-runtime-approvers:
   - gerred
+  - shawn-hurley
 
   # folks who can review and LGTM any PRs in the repo (doesn't
   # include approvers & admins -- those count too via the OWNERS
   # file)
   controller-runtime-reviewers:
   - alvaroaleman
-  - shawn-hurley
   - joelanford
   - alenkacz
   - vincepri

README.md

@@ -2,7 +2,12 @@
 
 # Kubernetes controller-runtime Project
 
-The Kubernetes controller-runtime Project is a set of go libraries for building Controllers.
+The Kubernetes controller-runtime Project is a set of go libraries for building
+Controllers. It is leveraged by [Kubebuilder](https://book.kubebuilder.io/) and
+[Operator SDK](https://github.com/operator-framework/operator-sdk). Both are
+a great place to start for new projects. See
+[Kubebuilder's Quick Start](https://book.kubebuilder.io/quick-start.html) to
+see how it can be used.
 
 Documentation:
 
@@ -11,6 +16,7 @@ Documentation:
 - [Creating a manager](https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/manager#example-New)
 - [Creating a controller](https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/controller#example-New)
 - [Examples](https://github.com/kubernetes-sigs/controller-runtime/blob/master/examples)
+- [Designs](https://github.com/kubernetes-sigs/controller-runtime/blob/master/designs)
 
 # Versioning, Maintenance, and Compatibility
 

designs/README.md

@@ -0,0 +1,36 @@
+Designs
+=======
+
+These are design documents for changes to Controller Runtime They exist
+to help document the design processes that go into writing Controller 
+Runtime, but may not be up-to-date (more below).
+
+Not all changes to Controller Runtime need a design document -- only major
+ones. use your best judgement.
+
+When submitting a design document, we encourage having written
+a proof-of-concept, and it's perfectly acceptable to submit the
+proof-of-concept PR simultaneously with the design document, as the
+proof-of-concept process can help iron out wrinkles and can help with the
+`Example` section of the template.
+
+## Out-of-Date Designs
+
+**Controller Runtime documentation
+[GoDoc](https://godoc.org/sigs.k8s.io/controller-runtime) should be
+considered the canonical, update-to-date reference and architectural
+documentation** for Controller Runtime.
+
+However, if you see an out-of-date design document, feel free to submit
+a PR marking it as such, and add an addendum linking to issues documenting
+why things changed.  For example:
+
+```markdown
+
+# Out of Date
+
+This change is out of date.  It turns out curly braces a frustrating to
+type, so we had to abandon functions entirely, and have users specify
+custom functionality using strings of Common LISP instead.  See #000 for
+more information.
+```

designs/template.md

@@ -0,0 +1,21 @@
+Title of the Design
+===================
+
+<!-- Describe your change here.  This is purposefully freeform: we want
+enough information to evaluate the design, but not so much that you're
+annoyed by the overall design process and decide to bake cookies instead.
+-->
+
+## Example
+
+<!-- Specify an example of how the user would use this.  It helps other
+contributors get a feel for how this will look in real code, and provides
+a good opportunity to evaluate the end-user feel of the code for yourself.
+
+If you find yourself groaning at verbosity, copy-and-pasting a lot, or
+writing a bunch of tiny helper functions, it's a good indication that you
+might need to re-evaluate the user experience of your design.
+
+This is also a good opportunity to stop and write a proof-of-concept, if
+you haven't already, which should help catch practical nits with the
+design. -->

go.mod

@@ -6,18 +6,22 @@ require (
 	github.com/evanphx/json-patch v4.5.0+incompatible
 	github.com/go-logr/logr v0.1.0
 	github.com/go-logr/zapr v0.1.0
-	github.com/golang/groupcache v0.0.0-20180513044358-24b0969c4cb7 // indirect
+	github.com/golang/groupcache v0.0.0-20190129154638-5b532d6fd5ef // indirect
 	github.com/googleapis/gnostic v0.3.1 // indirect
 	github.com/imdario/mergo v0.3.6 // indirect
 	github.com/onsi/ginkgo v1.11.0
 	github.com/onsi/gomega v1.8.1
 	github.com/prometheus/client_golang v1.0.0
 	github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90
+	go.uber.org/atomic v1.4.0 // indirect
 	go.uber.org/zap v1.10.0
+	golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550 // indirect
+	golang.org/x/sys v0.0.0-20190922100055-0a153f010e69 // indirect
 	golang.org/x/time v0.0.0-20190308202827-9d24e82272b4
-	golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7
 	gomodules.xyz/jsonpatch/v2 v2.0.1
+	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
 	gopkg.in/fsnotify.v1 v1.4.7
+	gopkg.in/yaml.v2 v2.2.7 // indirect
 	k8s.io/api v0.17.2
 	k8s.io/apiextensions-apiserver v0.17.2
 	k8s.io/apimachinery v0.17.2