From 38ff4ed2c329d2693287515989f99cc85719d309 Mon Sep 17 00:00:00 2001 From: Jared Jakacky Date: Mon, 18 May 2026 13:57:10 -0500 Subject: [PATCH] docs(readme): document example build target --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1405cee..2c2b437 100644 --- a/README.md +++ b/README.md @@ -229,11 +229,14 @@ This repository uses `make` for local verification: ```bash make verify +make build-examples make test-race make govulncheck ``` -`make verify` checks formatting, runs `go vet`, runs tests, builds the runnable examples, and verifies that `go.mod` and `go.sum` are tidy. CI runs verification and race tests on the supported Go versions, and release tags are gated by verification, race tests, and `govulncheck` before publishing. +`make verify` checks formatting, runs `go vet`, runs tests, builds the runnable examples, and verifies that `go.mod` and `go.sum` are tidy. `make build-examples` is available when you only want to compile the runnable examples. + +CI runs verification and race tests on the supported Go versions. Release tags are gated by those jobs plus `govulncheck` before publishing. ## Issues and Scope