Skip to content

build(ci): verify docs and runnable examples #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jaredjakacky merged 3 commits into from
May 18, 2026
Merged

build(ci): verify docs and runnable examples #15

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
50b41b3
build(ci): verify docs and runnable examples
jaredjakacky May 18, 2026
7f8e15e
build(ci): simplify example verification
jaredjakacky May 18, 2026
c36f765
build(ci): simplify example verification
jaredjakacky May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down