build: document and script release steps (#5483)

Author: jacobbednarz

.goreleaser.yml

@@ -17,22 +17,14 @@ builds:
       - linux
       - windows
     goarch:
-      - "386"
       - amd64
-      - arm
       - arm64
-    ignore:
-      - goarch: "386"
-        goos: darwin
-      - goarch: arm
-        goos: windows
-      - goarch: arm64
-        goos: freebsd
-      - goarch: arm64
-        goos: windows
     binary: "{{ .ProjectName }}_v{{ .Version }}"
+    hooks:
+      post:
+        - cp terraform-registry-manifest.json dist/{{ .ProjectName }}_{{ .Version }}_manifest.json
 archives:
-  - formats: [ 'zip' ]
+  - formats: ["zip"]
     name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
 checksum:
   name_template: "{{ .ProjectName }}_{{ .Version }}_SHA256SUMS"
@@ -45,7 +37,7 @@ signs:
     args:
       - "--batch"
       - "--local-user"
-      - "{{ .Env.GPG_FINGERPRINT }}" # set this environment variable for your signing key
+      - "{{ .Env.GPG_FINGERPRINT }}"
       - "--output"
       - "${signature}"
       - "--detach-sign"

RELEASING.md

@@ -0,0 +1,27 @@
+# Releasing
+
+## GitHub (Recommended)
+
+> [!NOTE]
+> Releasing with GitHub Actions is currently not usable due to the Golang build cache being larger than the available resources for the free runners. There is work to remedy this but in the meantime, you must follow the manual steps.
+
+- Merge release PR.
+- If needed, trigger the resync Terraform registry releases CI job.
+
+## Manual
+
+> [!NOTE]
+> Depending on your local Go build cache, you may hit "out of disk space" issues in $TMP" errors. To workaround this, run the release script multiple times while the cache is rebuilt. The script is idempotent and is fine to be run multiple times to get all the artifacts.
+
+- Merge GitHub release PR.
+- Load Terraform GPG key into local keychain.
+- Set the GPG fingerprint.
+  ```
+  export GPG_FINGERPRINT="..."
+  ```
+- Ensure GoReleaser is installed.
+- Locally checkout the release tag.
+- Run `script/release`.
+- Open GitHub release and edit it.
+- Upload all binary archives, `terraform-provider-cloudflare_<version>_SHA256SUMS`, `terraform-provider-cloudflare_<version>_SHA256SUMS.sig` and `terraform-provider-cloudflare_<version>_manifest.json` to the GitHub release.
+- Trigger the resync Terraform registry releases CI job.

scripts/release

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+echo "==> Checking environment is correctly configured"
+if ! command -v goreleaser 2>&1 >/dev/null; then
+  echo "goreleaser is not installed."
+  exit 1
+fi
+
+if [ -z "${GPG_FINGERPRINT}" ]; then
+  echo "GPG_FINGERPRINT not defined. You must export it before continuing."
+  exit 1
+fi
+
+echo "==> Running GoReleaser"
+# only use half of the available CPU to not starve other apps.
+cpu=$(sysctl -n hw.ncpu)
+usable_cpu=$(($cpu / 2))
+goreleaser release --clean --timeout 2h --skip "announce,publish" -p $usable_cpu