changelog is no longer generated to be committed, and installation doc

have been updated to remove version string dependency

Author: estroz

.gitignore

@@ -5,6 +5,7 @@
 /build
 /dist
 /tools/bin
+/changelog/generated
 
 # Website
 website/public/

.goreleaser.yml

@@ -1,20 +1,26 @@
+# Global environment variables for builds.
+env:
+  - CGO_ENABLED=0
+  - GO111MODULE=on
+  - REPO=github.com/operator-framework/operator-sdk
+
+# Hooks to run before any build is run.
 before:
   hooks:
     - go version | grep --quiet "go1\.15\.2" || echo "Go binary version must be 1.15.2"
     - go mod download
+
+# Binary builds.
 builds:
+  # operator-sdk build steps
   - id: operator-sdk
     main: ./cmd/operator-sdk
     binary: operator-sdk
-    env:
-      - CGO_ENABLED=0
-      - GO111MODULE=on
-      - REPO=github.com/operator-framework/operator-sdk
     mod_timestamp: "{{ .CommitTimestamp }}"
     asmflags:
-      - all=-trimpath={{ dir .ArtifactPath | dir | dir | dir }}
+      - all=-trimpath={{ .Env.PWD }}
     gcflags:
-      - all=-trimpath={{ dir .ArtifactPath | dir | dir | dir }}
+      - all=-trimpath={{ .Env.PWD }}
     ldflags:
       - -X {{ .Env.REPO }}/internal/version.Version={{ if not .IsSnapshot }}v{{ end }}{{ .Version }}
       - -X {{ .Env.REPO }}/internal/version.GitVersion={{ .Tag }}
@@ -40,15 +46,11 @@ builds:
   - id: ansible-operator
     main: ./cmd/ansible-operator
     binary: ansible-operator
-    env:
-      - CGO_ENABLED=0
-      - GO111MODULE=on
-      - REPO=github.com/operator-framework/operator-sdk
     mod_timestamp: "{{ .CommitTimestamp }}"
     asmflags:
-      - all=-trimpath={{ dir .ArtifactPath | dir | dir | dir }}
+      - all=-trimpath={{ .Env.PWD }}
     gcflags:
-      - all=-trimpath={{ dir .ArtifactPath | dir | dir | dir }}
+      - all=-trimpath={{ .Env.PWD }}
     ldflags:
       - -X {{ .Env.REPO }}/internal/version.Version={{ if not .IsSnapshot }}v{{ end }}{{ .Version }}
       - -X {{ .Env.REPO }}/internal/version.GitVersion={{ .Tag }}
@@ -74,15 +76,11 @@ builds:
   - id: helm-operator
     main: ./cmd/helm-operator
     binary: helm-operator
-    env:
-      - CGO_ENABLED=0
-      - GO111MODULE=on
-      - REPO=github.com/operator-framework/operator-sdk
     mod_timestamp: "{{ .CommitTimestamp }}"
     asmflags:
-      - all=-trimpath={{ dir .ArtifactPath | dir | dir | dir }}
+      - all=-trimpath={{ .Env.PWD }}
     gcflags:
-      - all=-trimpath={{ dir .ArtifactPath | dir | dir | dir }}
+      - all=-trimpath={{ .Env.PWD }}
     ldflags:
       - -X {{ .Env.REPO }}/internal/version.Version={{ if not .IsSnapshot }}v{{ end }}{{ .Version }}
       - -X {{ .Env.REPO }}/internal/version.GitVersion={{ .Tag }}
@@ -111,9 +109,10 @@ snapshot:
 # We don't use archives, so skip creating them.
 archives:
   - format: binary
+    name_template: "{{ .Binary }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}{{ if .Mips }}_{{ .Mips }}{{ end }}"
 
 checksum:
-  name_template: 'checksums.txt'
+  name_template: "checksums.txt"
 
 # Sign checksum files with the local default PGP key.
 # TODO(estroz): configure CI PGP key

CHANGELOG.md

@@ -145,6 +145,11 @@ test-e2e-integration:: ## Run integration tests
 	./hack/tests/integration.sh
 	./hack/tests/subcommand-olm-install.sh
 
+.PHONY: release
+release: ## Release the Operator SDK
+	@rm -rf dist/
+	$(MAKE) -f release/Makefile GO_BUILD_ARGS='$(GO_BUILD_ARGS)'
+
 .DEFAULT_GOAL := help
 .PHONY: help
 help: ## Show this help screen.

Makefile

@@ -4,7 +4,10 @@
 SHELL = /bin/bash
 .SHELLFLAGS = -O extglob -c
 
-GIT_VERSION = $(shell git describe --dirty --always --tags)
+# Repo prefix for image tags.
+IMAGE_REPO ?= quay.io/operator-framework
+
+# Dry run flags.
 ifneq ($(DRY_RUN),)
 SNAPSHOT_FLAGS = --snapshot --skip-publish --rm-dist
 TAG ?= $(GIT_VERSION)
@@ -20,34 +23,37 @@ all: release
 
 .PHONY: check_tag
 check_tag:
-ifeq ($(TAG),)
+ifeq (,$(TAG))
 	$(error "TAG must be set to a release tag")
 endif
 
+.PHONY: check_k8s_version
+check_k8s_version:
+ifeq (,$(K8S_VERSION))
+	$(error "K8S_VERSION must be set to a Kubernetes release version")
+endif
+
+.PHONY: release
+TOOLS_DIR ?= tools/bin
+SCRIPTS_DIR ?= tools/scripts
+release: check_tag check_k8s_version changelog ## Release all operator-sdk binaries with notes. $TAG must be explicitly set to avoid ambiguity.
+	$(SCRIPTS_DIR)/fetch goreleaser
+	GORELEASER_CURRENT_TAG=$(TAG) K8S_VERSION=$(K8S_VERSION) $(TOOLS_DIR)/goreleaser $(SNAPSHOT_FLAGS) --release-notes=changelog/generated/$(TAG).md --parallelism 5
+
 .PHONY: changelog
 changelog: check_tag ## Generate the changelog.
-	mkdir -p changelog/generated
+	@mkdir -p changelog/generated
 	go run ./release/changelog/gen-changelog.go -tag=$(TAG) -changelog=changelog/generated/$(TAG).md
 ifeq ($(DRY_RUN),)
 	rm -f ./changelog/fragments/!(00-template.yaml)
 endif
 
-.PHONY: release
-K8S_VERSION = v1.18.2
-release: check_tag goreleaser ## Release all operator-sdk binaries with notes. $TAG must be explicitly set to avoid ambiguity.
-	GORELEASER_CURRENT_TAG=$(TAG) K8S_VERSION=$(K8S_VERSION) ./bin/goreleaser $(SNAPSHOT_FLAGS) --release-notes=changelog/generated/$(TAG).md --parallelism 5
-
-.PHONY: goreleaser
-goreleaser: ## Install goreleaser locally.
-	@[[ -f ./bin/goreleaser ]] || curl -sfL https://install.goreleaser.com/github.com/goreleaser/goreleaser.sh | sh
-
 .PHONY: image-push image-push-multiarch
 IMAGE_TARGET_LIST = operator-sdk helm-operator ansible-operator scorecard-test scorecard-test-kuttl custom-scorecard-tests
 image-push: $(foreach i,$(IMAGE_TARGET_LIST),image-push/$(i)) ## Push all images for the host architecture.
 image-push-multiarch: $(foreach i,$(IMAGE_TARGET_LIST),image-push-multiarch/$(i)) ## Push the manifest list for all architectures.
 
 # Push image for an architecture.
-IMAGE_REPO ?= quay.io/operator-framework
 GO_ARCH := $(shell go env GOARCH)
 image-push/%: IMAGE_PUSH_TAG = $(IMAGE_REPO)/$*-$(GO_ARCH)
 image-push/%:

release/Makefile

@@ -34,6 +34,12 @@ fetch() {
       ver_cmd="cat ${DEST}/.envtest_version 2>/dev/null"
       fetch_cmd="(test -f ${DEST}/setup-envtest.sh || curl -sSLo ${DEST}/setup-envtest.sh https://raw.githubusercontent.com/kubernetes-sigs/controller-runtime/v${ver}/hack/setup-envtest.sh) && (source ${DEST}/setup-envtest.sh; fetch_envtest_tools ${DEST}/../) && echo ${ver} > ${DEST}/.envtest_version"
       ;;
+    "goreleaser")
+      [[ -z "$ver" ]] || (echo "cannot set goreleaser version" && exit 1)
+      ver="${DEST}/goreleaser"
+      ver_cmd="command -v ${DEST}/goreleaser"
+      fetch_cmd="curl -sfL https://install.goreleaser.com/github.com/goreleaser/goreleaser.sh | sh -s -- -b ${DEST}"
+      ;;
     *)
       echo "unknown tool $tool"
       return 1

tools/scripts/fetch

@@ -1,7 +1,6 @@
 ---
-title: "Installation"
-linkTitle: "Installation"
-date: 2020-03-25
+title: Installation
+linkTitle: Installation
 weight: 2
 description: Install the Operator SDK CLI
 ---
@@ -24,87 +23,60 @@ description: Install the Operator SDK CLI
 If you are using [Homebrew][homebrew_tool], you can install the SDK CLI tool with the following command:
 
 ```sh
-$ brew install operator-sdk
+brew install operator-sdk
 ```
 
 ## Install from GitHub release
 
 ### Download the release binaries
 
 ```sh
-# Set the release version variable
-$ RELEASE_VERSION=v1.1.0
 # Linux
-$ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/operator-sdk-${RELEASE_VERSION}-x86_64-linux-gnu
-$ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/ansible-operator-${RELEASE_VERSION}-x86_64-linux-gnu
-$ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/helm-operator-${RELEASE_VERSION}-x86_64-linux-gnu
+curl -Lo operator-sdk https://github.com/operator-framework/operator-sdk/releases/latest/download/operator-sdk_"$(uname -m)"_linux
 # macOS
-$ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/operator-sdk-${RELEASE_VERSION}-x86_64-apple-darwin
-$ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/ansible-operator-${RELEASE_VERSION}-x86_64-apple-darwin
-$ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/helm-operator-${RELEASE_VERSION}-x86_64-apple-darwin
+curl -Lo operator-sdk https://github.com/operator-framework/operator-sdk/releases/latest/download/operator-sdk_"$(uname -m)"_darwin
 ```
 
 #### Verify the downloaded release binaries
 
 ```sh
-# Linux
-$ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/operator-sdk-${RELEASE_VERSION}-x86_64-linux-gnu.asc
-$ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/ansible-operator-${RELEASE_VERSION}-x86_64-linux-gnu.asc
-$ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/helm-operator-${RELEASE_VERSION}-x86_64-linux-gnu.asc
-# macOS
-$ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/operator-sdk-${RELEASE_VERSION}-x86_64-apple-darwin.asc
-$ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/ansible-operator-${RELEASE_VERSION}-x86_64-apple-darwin.asc
-$ curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${RELEASE_VERSION}/helm-operator-${RELEASE_VERSION}-x86_64-apple-darwin.asc
+curl -LO https://github.com/operator-framework/operator-sdk/releases/latest/download/checksums.txt
 ```
 
 To verify a release binary using the provided asc files, place the binary and corresponding asc file into the same directory and use the corresponding command:
 
 ```sh
-# Linux
-$ gpg --verify operator-sdk-${RELEASE_VERSION}-x86_64-linux-gnu.asc
-$ gpg --verify ansible-operator-${RELEASE_VERSION}-x86_64-linux-gnu.asc
-$ gpg --verify helm-operator-${RELEASE_VERSION}-x86_64-linux-gnu.asc
-# macOS
-$ gpg --verify operator-sdk-${RELEASE_VERSION}-x86_64-apple-darwin.asc
-$ gpg --verify ansible-operator-${RELEASE_VERSION}-x86_64-apple-darwin.asc
-$ gpg --verify helm-operator-${RELEASE_VERSION}-x86_64-apple-darwin.asc
+gpg --verify ./operator-sdk
 ```
 
 If you do not have the maintainers public key on your machine, you will get an error message similar to this:
 
-```sh
-$ gpg --verify operator-sdk-${RELEASE_VERSION}-x86_64-apple-darwin.asc
-$ gpg: assuming signed data in 'operator-sdk-${RELEASE_VERSION}-x86_64-apple-darwin'
-$ gpg: Signature made Fri Apr  5 20:03:22 2019 CEST
-$ gpg:                using RSA key <KEY_ID>
-$ gpg: Can't check signature: No public key
+```console
+$ gpg --verify operator-sdk
+gpg: assuming signed data in './operator-sdk.asc'
+gpg: Signature made Fri Apr  5 20:03:22 2019 CEST
+gpg:                using RSA key <KEY_ID>
+gpg: Can\'t check signature: No public key
 ```
 
-To download the key, use the following command, replacing `$KEY_ID` with the RSA key string provided in the output of the previous command:
+To download the key, use the following command, replacing `$KEY_ID` with the "RSA key" string provided in the output of the previous command:
 
 ```sh
-$ gpg --recv-key "$KEY_ID"
+gpg --recv-key "$KEY_ID"
 ```
 
 You'll need to specify a key server if one hasn't been configured. For example:
 
 ```sh
-$ gpg --keyserver keyserver.ubuntu.com --recv-key "$KEY_ID"
+gpg --keyserver keyserver.ubuntu.com --recv-key "$KEY_ID"
 ```
 
 Now you should be able to verify the binary.
 
 ### Install the release binary in your PATH
 
 ```sh
-# Linux
-$ chmod +x operator-sdk-${RELEASE_VERSION}-x86_64-linux-gnu && sudo mkdir -p /usr/local/bin/ && sudo cp operator-sdk-${RELEASE_VERSION}-x86_64-linux-gnu /usr/local/bin/operator-sdk && rm operator-sdk-${RELEASE_VERSION}-x86_64-linux-gnu
-$ chmod +x ansible-operator-${RELEASE_VERSION}-x86_64-linux-gnu && sudo mkdir -p /usr/local/bin/ && sudo cp ansible-operator-${RELEASE_VERSION}-x86_64-linux-gnu /usr/local/bin/ansible-operator && rm ansible-operator-${RELEASE_VERSION}-x86_64-linux-gnu
-$ chmod +x helm-operator-${RELEASE_VERSION}-x86_64-linux-gnu && sudo mkdir -p /usr/local/bin/ && sudo cp helm-operator-${RELEASE_VERSION}-x86_64-linux-gnu /usr/local/bin/helm-operator && rm helm-operator-${RELEASE_VERSION}-x86_64-linux-gnu
-# macOS
-$ chmod +x operator-sdk-${RELEASE_VERSION}-x86_64-apple-darwin && sudo mkdir -p /usr/local/bin/ && sudo cp operator-sdk-${RELEASE_VERSION}-x86_64-apple-darwin /usr/local/bin/operator-sdk && rm operator-sdk-${RELEASE_VERSION}-x86_64-apple-darwin
-$ chmod +x ansible-operator-${RELEASE_VERSION}-x86_64-apple-darwin && sudo mkdir -p /usr/local/bin/ && sudo cp ansible-operator-${RELEASE_VERSION}-x86_64-apple-darwin /usr/local/bin/ansible-operator && rm ansible-operator-${RELEASE_VERSION}-x86_64-apple-darwin
-$ chmod +x helm-operator-${RELEASE_VERSION}-x86_64-apple-darwin && sudo mkdir -p /usr/local/bin/ && sudo cp helm-operator-${RELEASE_VERSION}-x86_64-apple-darwin /usr/local/bin/helm-operator && rm helm-operator-${RELEASE_VERSION}-x86_64-apple-darwin
+chmod +x operator-sdk && sudo mv operator-sdk /usr/local/bin/
 ```
 
 ## Compile and install from master
@@ -117,11 +89,11 @@ $ chmod +x helm-operator-${RELEASE_VERSION}-x86_64-apple-darwin && sudo mkdir -p
 - [go][go_tool] version v1.15+.
 
 ```sh
-$ git clone https://github.com/operator-framework/operator-sdk
-$ cd operator-sdk
-$ git checkout master
-$ make tidy
-$ make install
+git clone https://github.com/operator-framework/operator-sdk
+cd operator-sdk
+git checkout master
+make tidy
+make install
 ```
 
 **Note:** Ensure that your `GOPROXY` is set with its default value for Go