Add CI check for auto-generated files (#336)

* add CI validation check to make sure all generated files are part of the PR

* seaprate out set default operator VERSION to 'ensure-generate-is-noop' target

Author: VineethReddy02

.github/workflows/continuous-integration.yaml

@@ -22,6 +22,10 @@ jobs:
     - name: "install kubebuilder"
       run: ./hack/install-kubebuilder.sh
 
+    - uses: jpkrohling/[email protected]
+      with:
+        operator-sdk-version: v1.9.0
+
     - name: "basic checks"
       run: make ci
 

CONTRIBUTING.md

@@ -28,7 +28,7 @@ $ gh pr create
 
 Build the manifests, install the CRD and run the operator as a local process:
 ```
-$ make manifests install run
+$ make bundle install run
 ```
 
 ### Deployment with webhooks
@@ -47,7 +47,7 @@ make cert-manager
 Once it's ready, the following can be used to build and deploy a manager, along with the required webhook configuration:
 
 ```
-make manifests container container-push deploy
+make bundle container container-push deploy
 ```
 
 By default, it will generate an image following the format `quay.io/${USER}/opentelemetry-operator:${VERSION}`. You can set the following env vars in front of the `make` command to override parts or the entirety of the image:

Makefile

@@ -3,6 +3,7 @@ VERSION ?= "$(shell git describe --tags | sed 's/^v//')"
 VERSION_DATE ?= $(shell date -u +'%Y-%m-%dT%H:%M:%SZ')
 VERSION_PKG ?= "github.com/open-telemetry/opentelemetry-operator/internal/version"
 OTELCOL_VERSION ?= "$(shell grep -v '\#' versions.txt | grep opentelemetry-collector | awk -F= '{print $$2}')"
+OPERATOR_VERSION ?= "$(shell grep -v '\#' versions.txt | grep operator | awk -F= '{print $$2}')"
 LD_FLAGS ?= "-X ${VERSION_PKG}.version=${VERSION} -X ${VERSION_PKG}.buildDate=${VERSION_DATE} -X ${VERSION_PKG}.otelCol=${OTELCOL_VERSION}"
 
 # Image URL to use all building/pushing image targets
@@ -43,11 +44,16 @@ endif
 KUBE_VERSION ?= 1.21
 KIND_CONFIG ?= kind-$(KUBE_VERSION).yaml
 
+ensure-generate-is-noop: VERSION=$(OPERATOR_VERSION)
+ensure-generate-is-noop: generate bundle
+	@git diff -s --exit-code api/v1alpha1/zz_generated.*.go || (echo "Build failed: a model has been changed but the generated resources aren't up to date. Run 'make generate' and update your PR." && exit 1)
+	@git diff -s --exit-code bundle config || (echo "Build failed: the bundle, config files has been changed but the generated bundle, config files aren't up to date. Run 'make bundle' and update your PR." && exit 1)
+
 all: manager
 ci: test
 
 # Run tests
-test: generate fmt vet manifests
+test: generate fmt vet ensure-generate-is-noop
 	go test ${GOTEST_OPTS} ./...
 
 # Build manager binary

bundle/manifests/opentelemetry-operator.clusterserviceversion.yaml

@@ -21,7 +21,7 @@ metadata:
     containerImage: quay.io/opentelemetry/opentelemetry-operator
     createdAt: "2020-12-16T13:37:00+00:00"
     description: Provides the OpenTelemetry components, including the Collector
-    operators.operatorframework.io/builder: operator-sdk-v1.9.0
+    operators.operatorframework.io/builder: operator-sdk-v1.8.0+git
     operators.operatorframework.io/project_layout: go.kubebuilder.io/v2
     repository: github.com/open-telemetry/opentelemetry-operator
     support: OpenTelemetry Community

versions.txt

@@ -4,5 +4,5 @@
 # the docs as well.
 opentelemetry-collector=0.29.0
 
-# Represents the next release of the OpenTelemetry Operator.
+# Represents the current release of the OpenTelemetry Operator.
 operator=0.29.0