docs: mirror remaining recipes as runnable example workflows#79
Merged
Conversation
- New examples/{pytest,run-mission-script,skip-on-docs,multi-version}.yml extract the workflow YAML from each docs/recipes/*.md page verbatim, with a header comment naming the companion recipe. examples/docker-mode.yml from #78 already covers docker.md.
- Each docs/recipes/*.md gains a "Runnable copy:" line under the H1 pointing at examples/<file>.yml on the v0 branch. Applied to all five recipe pages (docker.md included; #78 did not backfill it).
- README gains an "Examples" subsection between "Documentation" and "Verifying images" listing every example with a one-line summary, and noting that the files live outside .github/workflows/ so GitHub does not auto-run them in this repo.
Closes #67
The "auto-run" sentence was a contributor-facing rationale that doesn't earn its keep in the user-facing README.
djankov
added a commit
that referenced
this pull request
May 2, 2026
- Bumps `package.json` + lockfile to `0.3.0` and aggregates the `[0.3.0]` CHANGELOG section over PRs #70, #72, #74, #75, #76, #77, #78, #79, #80 (Docker base image, GHCR publish, smoke gate, cosign signing, container recipe + examples, Marketplace pass). - Backfills the missing `## [0.1.0] - 2026-04-30` CHANGELOG header that the v0.2 cut left orphaned. - Drops the now-shipped v0.2 row from the README roadmap and rewrites the v0.3 row to reflect what actually shipped (semantic-release deferred per #64); `_(current)_` marker moves to v0.3. - Flips the two `docs/faq.md` paragraphs that still described the GHCR image and cosign signing as planned, and drops the stale "cut by semantic-release" comment in `docker.yml`. Closes #69
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
examples/{pytest,run-mission-script,skip-on-docs,multi-version}.yml— runnable workflow files extracted verbatim from each recipe page, matching the header-comment + raw-YAML convention set byexamples/docker-mode.yml(docs: container-mode recipe + example workflow #78). Files live underexamples/rather than.github/workflows/so GitHub does not auto-run them in this repo.pytest.md,run-mission-script.md,skip-on-docs.md,multi-version.md,docker.md) pointing at the correspondingexamples/*.ymlon thev0branch.docker.mdis included because docs: container-mode recipe + example workflow #78 didn't backfill it; the convention applies uniformly going forward.Test plan
examples/*.ymlparses as valid workflow YAML (verified locally withyaml.safe_load).v0(theblob/v0/...URLs are intentionally pinned to the major branch, notmain).examples/.Closes #67