Automate manifest update out of README.md

.github/workflows/operator-metadata.yml

@@ -39,7 +39,7 @@ jobs:
       run: |
         export PATH=$HOME/go/bin:$PATH
         make manifests generate
-        make bundle
+        touch README.md ; make bundle
         rm deploy/falcon-operator.yaml && make deploy/falcon-operator.yaml
         find ./bundle* -type f -exec sed -i -e 's/operator-sdk-v1.7.1+git/operator-sdk-v1.8.0/g' {} \;
 

Makefile

@@ -109,7 +109,7 @@ endef
 
 # Generate bundle manifests and metadata, then validate generated files.
 .PHONY: bundle
-bundle: manifests kustomize operator-sdk
+bundle: manifests kustomize operator-sdk config/manifests/bases/falcon-operator.clusterserviceversion.yaml
 	operator-sdk generate kustomize manifests -q
 	cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMG)
 	$(KUSTOMIZE) build config/manifests | operator-sdk generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)
@@ -143,3 +143,6 @@ deploy/parts/crd-falconnodesensors.yaml: bundle/manifests/falcon.crowdstrike.com
 
 deploy/falcon-operator.yaml: deploy/parts/crd-falconcontainers.yaml deploy/parts/crd-falconnodesensors.yaml deploy/parts/ns.yaml deploy/parts/role.yaml deploy/parts/service_account.yaml deploy/parts/role_binding.yaml deploy/parts/operator.yaml
 	cat $^ > $@
+
+config/manifests/bases/falcon-operator.clusterserviceversion.yaml: README.md
+	hack/update-manifest.sh $@ $^

bundle/manifests/falcon-operator.clusterserviceversion.yaml

@@ -74,7 +74,7 @@ spec:
       kind: FalconNodeSensor
       name: falconnodesensors.falcon.crowdstrike.com
       version: v1alpha1
-  description: |
+  description: |-
     Falcon Operator installs CrowdStrike Falcon Container Sensor on the cluster.
 
     Falcon Operator is an open source project, not a CrowdStrike product. As such it carries no formal support, expressed or implied.

config/manifests/bases/falcon-operator.clusterserviceversion.yaml

@@ -27,7 +27,7 @@ spec:
       kind: FalconNodeSensor
       name: falconnodesensors.falcon.crowdstrike.com
       version: v1alpha1
-  description: |
+  description: |-
     Falcon Operator installs CrowdStrike Falcon Container Sensor on the cluster.
 
     Falcon Operator is an open source project, not a CrowdStrike product. As such it carries no formal support, expressed or implied.

hack/update-manifest.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -e -o pipefail
+
+readme="${2}"
+last_banner_line=$(cat $readme | grep --line-number '\[!\[' | tail -n 1 | sed 's/:.*$//g')
+let "first_readme_line=last_banner_line+1"
+export content="$(tail -n +${first_readme_line} ${readme} | sed 's/(docs\//(https:\/\/github.com\/CrowdStrike\/falcon-operator\/tree\/main\/docs\//g' )"
+yq -i e '.spec.description=strenv(content)' "${1}"
+operator-sdk generate kustomize manifests -q