README and releaser (#2)

Author: jakthom

.github/workflows/release.yml

@@ -137,32 +137,15 @@ jobs:
           done
           find internal/native/lib -type f -print | sort
 
-      - name: Generate checksums
-        run: make checksums
+      - name: Stage release assets
+        run: make stage.release.assets
 
-      - name: Verify checksums
-        run: make verify.checksums
+      - name: Verify release assets
+        run: make verify.release.assets
 
       - name: Verify downloaded release artifacts
         run: make verify.release.downloaded
 
-      - name: Stage release assets
-        run: |
-          set -euo pipefail
-          tag="${{ steps.version.outputs.release_tag }}"
-          rm -rf dist
-          mkdir -p dist
-          while IFS= read -r file; do
-            platform="$(basename "$(dirname "${file}")")"
-            base="$(basename "${file}")"
-            cp "${file}" "dist/datafusion-go-${tag}-${platform}-${base}"
-          done < <(find internal/native/lib -mindepth 2 -maxdepth 2 -type f \( -name 'libdatafusion_go.a' -o -name 'libdatafusion_go.so' -o -name 'libdatafusion_go.dylib' -o -name 'datafusion_go.dll' \) -print | sort)
-          cd dist
-          shasum -a 256 datafusion-go-* > SHA256SUMS
-          shasum -a 256 -c SHA256SUMS
-          cd ..
-          cp dist/SHA256SUMS internal/native/lib/SHA256SUMS
-
       - name: Prepare release notes
         id: notes
         run: |

CONTRIBUTING.md

@@ -26,6 +26,7 @@ make test.static
 Run the release verification path for already-bundled/downloaded artifacts:
 
 ```sh
+make stage.release.assets
 make verify.release.downloaded
 ```
 
@@ -76,10 +77,14 @@ Use `make bundle` only when you intend to copy the current host build into `inte
 Before publishing, update `versions.toml`, run `make generate`, update
 `CHANGELOG.md`, and run the `Release` GitHub Actions workflow with
 `publish=false`. The workflow derives the tag from `versions.toml`, builds the
-native matrix, downloads all archives into one checkout, verifies checksums, runs
-Go/Rust/no-cgo tests, and runs a clean consumer-module smoke test without
-tagging or creating a GitHub release.
+native matrix, downloads all archives into one checkout, stages release assets
+using the exact filenames the runtime downloader requests, embeds the
+release-asset checksum manifest, and runs Go/Rust/no-cgo tests without tagging
+or creating a GitHub release.
 
 When the dry run succeeds, rerun the same workflow with `publish=true`. It tags
 commits the release-asset checksum manifest, tags that commit with the derived
-release tag, and uploads the generated native libraries plus checksums.
+release tag, and uploads the generated native libraries plus checksums. The tag
+must point at the commit containing release asset names in
+`internal/native/lib/SHA256SUMS`; otherwise `go get` consumers cannot verify or
+download native libraries automatically.

Makefile

@@ -1,6 +1,7 @@
 GOOS ?= $(shell go env GOOS)
 GOARCH ?= $(shell go env GOARCH)
 MACOSX_DEPLOYMENT_TARGET ?= 13.0
+DIST_DIR ?= dist
 NATIVE_PLATFORM := $(GOOS)-$(GOARCH)
 NATIVE_LIB_DIR := internal/native/lib/$(NATIVE_PLATFORM)
 NATIVE_LIB := $(NATIVE_LIB_DIR)/libdatafusion_go.a
@@ -39,7 +40,7 @@ else ifeq ($(GOOS),windows)
 STRIP_SHARED := strip --strip-unneeded
 endif
 
-.PHONY: generate generate.check rust bundle checksums verify.checksums test test.dynamic test.bundled test.source test.static consumer.smoke lint verify.release verify.release.downloaded clean
+.PHONY: generate generate.check rust bundle checksums verify.checksums stage.release.assets verify.release.assets test test.dynamic test.bundled test.source test.static consumer.smoke lint verify.release verify.release.downloaded clean
 
 generate:
 	go run ./internal/tools/genversions
@@ -66,6 +67,39 @@ verify.checksums:
 	test -s internal/native/lib/SHA256SUMS
 	cd internal/native/lib && shasum -a 256 -c SHA256SUMS
 
+stage.release.assets:
+	@metadata=$$(mktemp); \
+	go run ./internal/tools/genversions -github-output "$$metadata"; \
+	. "$$metadata"; \
+	rm -f "$$metadata"; \
+	rm -rf "$(DIST_DIR)"; \
+	mkdir -p "$(DIST_DIR)"; \
+	find internal/native/lib -mindepth 2 -maxdepth 2 -type f \( -name 'libdatafusion_go.a' -o -name 'libdatafusion_go.so' -o -name 'libdatafusion_go.dylib' -o -name 'datafusion_go.dll' \) -print | sort | while IFS= read -r file; do \
+		platform="$$(basename "$$(dirname "$$file")")"; \
+		base="$$(basename "$$file")"; \
+		cp "$$file" "$(DIST_DIR)/datafusion-go-$${release_tag}-$${platform}-$${base}"; \
+	done
+	cd "$(DIST_DIR)" && shasum -a 256 datafusion-go-* > SHA256SUMS
+	cd "$(DIST_DIR)" && shasum -a 256 -c SHA256SUMS
+	cp "$(DIST_DIR)/SHA256SUMS" internal/native/lib/SHA256SUMS
+
+verify.release.assets:
+	@metadata=$$(mktemp); \
+	go run ./internal/tools/genversions -github-output "$$metadata"; \
+	. "$$metadata"; \
+	rm -f "$$metadata"; \
+	cmp "$(DIST_DIR)/SHA256SUMS" internal/native/lib/SHA256SUMS; \
+	(cd "$(DIST_DIR)" && shasum -a 256 -c SHA256SUMS); \
+	for asset in \
+		"datafusion-go-$${release_tag}-darwin-arm64-libdatafusion_go.dylib" \
+		"datafusion-go-$${release_tag}-darwin-amd64-libdatafusion_go.dylib" \
+		"datafusion-go-$${release_tag}-linux-amd64-libdatafusion_go.so" \
+		"datafusion-go-$${release_tag}-linux-arm64-libdatafusion_go.so" \
+		"datafusion-go-$${release_tag}-windows-amd64-datafusion_go.dll"; do \
+		test -f "$(DIST_DIR)/$$asset"; \
+		grep -F "  $$asset" "$(DIST_DIR)/SHA256SUMS" >/dev/null; \
+	done
+
 test: bundle
 	$(MAKE) test.dynamic
 	$(MAKE) test.bundled
@@ -120,12 +154,12 @@ verify.release: test test.source test.static
 	$(MAKE) checksums
 	$(MAKE) verify.checksums
 
-verify.release.downloaded: verify.checksums test.bundled consumer.smoke test.source test.static
+verify.release.downloaded: verify.release.assets test.bundled test.source test.static
 	DATAFUSION_GO_LIBRARY=$(CURDIR)/$(NATIVE_SHARED) go test -race ./...
 	go vet ./...
 	cargo test --manifest-path rust/Cargo.toml --release
 	CGO_ENABLED=0 go test ./...
-	$(MAKE) verify.checksums
+	$(MAKE) verify.release.assets
 
 clean:
 	cargo clean --manifest-path rust/Cargo.toml