ci: build and vet _samples in CI

The _samples directory is excluded from go build ./... (Go ignores
_-prefixed paths), so a sample that fails to compile merges green.
Add a build-samples Makefile target and a CI job that compiles and
vets each _samples/*.go program."

Signed-off-by: Sean Chittenden <sean.chittenden@crowdstrike.com>

Author: sean-

.github/workflows/test-unit.yml

@@ -38,3 +38,14 @@ jobs:
         with: { go-version-file: 'go.mod' }
       - run: go version
       - run: make test-bench
+
+  samples:
+    name: Build samples
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+      - uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6
+        with: { go-version-file: 'go.mod' }
+      - run: go version
+      - run: make build-samples
+

CHANGELOG.md

@@ -6,6 +6,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ### Added
 
+- Add a `build-samples` Makefile target and a CI job that compiles and vets every `_samples/*.go` program, so example breakage is caught (the `_samples` directory is excluded from `go build ./...` because Go ignores `_`-prefixed paths)
 - Group document operations under a `client.Doc` sub-client and point-in-time operations under `client.PIT` (`Create`/`Delete`/`GetAll`/`DeleteAll`); `client.Document` and `client.PointInTime` remain as field aliases. The indices sub-client's canonical field is `client.Index`, with `client.Indices` and `client.Indexes` as aliases. `cmd/osgen` gains `--emit-v4-compat` (default true) to emit backward-compatibility forwarders so top-level `client.Bulk`/`MGet`/`Update`, `client.Document.Source`, and `client.PointInTime.Get` keep working (`client.Index` is not forwarded -- it is the indices sub-client field; use `client.Doc.Index`), and `--emit-v4-deprecation` (default false) to mark those forwarders deprecated
 - Add `cmd/osgen` code generator for typed path builders and API consumer files from the OpenAPI spec
 - `opensearchapi`: `NewClient` and `NewDefaultClient` inject `opensearchtransport.NewDefaultRouter` when `config.Client.Router` is nil, opting every client into intelligent request routing by default. The `OPENSEARCH_GO_ROUTER` env var controls the behavior: `=false`/`=0` suppresses both Router injection and auto-discovery; unset or any other value injects the Router and enables on-start discovery. ([#816](https://github.com/opensearch-project/opensearch-go/issues/816))

Makefile

@@ -132,6 +132,19 @@ test-bench:  ## Run benchmarks
 	@printf "\033[2m-> Running benchmarks...\033[0m\n"
 	go test -run=none -bench=. -benchmem -benchtime=200ms ./...
 
+build-samples:  ## Compile and vet each _samples/*.go program
+	@printf "\033[2m-> Building _samples...\033[0m\n"
+	@failed=0; \
+	for f in _samples/*.go; do \
+		printf "   %s\n" "$$f"; \
+		go build -o /dev/null "$$f" || failed=1; \
+		go vet "$$f" || failed=1; \
+	done; \
+	if [ $$failed -ne 0 ]; then \
+		printf "\033[31m-> _samples build/vet failed\033[0m\n"; \
+		exit 1; \
+	fi
+
 coverage:  ## Print test coverage report
 	@$(MAKE) gen-coverage
 	@go tool cover -func=$(PWD)/tmp/total.cov
@@ -888,5 +901,5 @@ help:  ## Display help
 #------------- <https://suva.sh/posts/well-documented-makefiles> --------------
 
 .DEFAULT_GOAL := help
-.PHONY: help backport cluster.runtime cluster.sysctl cluster.build cluster.start cluster.stop cluster.docker-build cluster.docker-up cluster.clean cluster.heterogeneous.cpu.1 cluster.heterogeneous.cpu.2 cluster.heterogeneous.roles cluster.homogeneous cluster.latency.asymmetric cluster.latency.symmetric cluster.latency.bimodal cluster.latency.graduated cluster.latency.clear cluster.latency.show gh.checks gh.checks.failed gh.fail gh.fail.full gh.fail.context gh.fail.summary coverage godoc lint lint.local release test test-all test-race test-bench test-integ test-unit linters linters.install
+.PHONY: help backport cluster.runtime cluster.sysctl cluster.build cluster.start cluster.stop cluster.docker-build cluster.docker-up cluster.clean cluster.heterogeneous.cpu.1 cluster.heterogeneous.cpu.2 cluster.heterogeneous.roles cluster.homogeneous cluster.latency.asymmetric cluster.latency.symmetric cluster.latency.bimodal cluster.latency.graduated cluster.latency.clear cluster.latency.show gh.checks gh.checks.failed gh.fail gh.fail.full gh.fail.context gh.fail.summary coverage godoc lint lint.local release test test-all test-race test-bench test-integ test-unit linters linters.install build-samples
 .SILENT: lint.markdown