Skip to content

ci: run the examples suite before a release too - #73

Merged
fadion merged 1 commit into
masterfrom
ci/release-runs-examples
Aug 27, 2026
Merged

fadion merged 1 commit into
masterfrom
ci/release-runs-examples

Conversation

@fadion

@fadion fadion commented Aug 27, 2026

Copy link
Copy Markdown
Owner

The release workflow's verify job runs the characterization suite and the README blocks, and did not run the examples. check-examples.sh was added to CI in #58 and never mirrored here, so a tag could publish a commit whose examples were broken. v1.0.0 was not, but only because CI caught them on master first, which is luck rather than a guarantee.

What changed

  • verify now runs scripts/check-examples.sh, so both workflows run the same three correctness suites.
  • Both files carry a comment pointing at the other. Nothing enforces that the lists agree, which is how they drifted in the first place.

Collapsing the three into one script would remove the drift outright, at the cost of what the separate steps buy: a failure attributed to the suite that failed rather than to a wrapper. Not worth trading for two files that change about once a year.

Note this PR touches .github/workflows/release.yml, so the release workflow builds all six archives without publishing, exercising the packaging alongside the change.

The release workflow's verify job runs the characterization suite and the
README blocks, and did not run the examples. check-examples.sh was added
to CI in #58 and never mirrored here, so between then and now a tag could
have published a commit whose examples were broken. v1.0.0 was not, but
only because CI caught them on master first, which is luck rather than a
guarantee.

The same class of thing as the two builtin name lists: two places that
have to say the same thing, with nothing making them. There is no check
here either, so both now carry a comment pointing at the other.

Collapsing the three into one script would remove the drift outright, and
costs the thing the separate steps buy: a failure is attributed to the
suite that failed rather than to a wrapper. Not worth trading for two
files that change about once a year.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@fadion
fadion merged commit e50d717 into master Aug 27, 2026
16 checks passed
@fadion
fadion deleted the ci/release-runs-examples branch August 27, 2026 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant