Repository navigation
docs: container-mode recipe + example workflow - #78
Merged
Merged
Conversation
Worked-example recipe for consuming ghcr.io/astro-tools/gmat:Rxxxxa as a jobs.*.container.image instead of running setup-gmat. Covers when to choose this shape over the action, picking a Python minor inside the image, multi-version matrix shape, and the actions/setup-python limitation. Cosign verification points at the existing README section. Companion runnable workflow at examples/docker-mode.yml mirrors the snippet as a complete .yml. Closes #66
djankov
marked this pull request as ready for review
May 2, 2026 21:24
4 tasks done
djankov
added a commit
that referenced
this pull request
May 2, 2026
- Adds 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 by examples/docker-mode.yml (#78).
- Adds a one-line "Runnable copy:" link at the top of all five recipe pages (pytest.md, run-mission-script.md, skip-on-docs.md, multi-version.md, docker.md) pointing at the corresponding examples/*.yml on the v0 branch. docker.md is included because #78 did not backfill it.
- Adds an "Examples" subsection to the README between "Documentation" and "Verifying images" listing each runnable example with a one-line summary.
Closes #67
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
docs/recipes/docker.mddocuments consumingghcr.io/astro-tools/gmat:Rxxxxaas ajobs.*.container.imageinstead of running the action — covers when to pick this shape, the workflow snippet, picking a Python minor inside the image's pyenv set, the multi-version matrix shape, and theactions/setup-pythonlimitation. Cosign verification callout links to the existing README "Verifying images" section.examples/docker-mode.ymlmirrors the recipe snippet as a complete.yml.docs/recipes/index.mdand registered in the MkDocsnavunder Recipes.Note: the published image is not pullable yet —
docker.ymlis in place but waits on the firstv*.*.*tag (semantic-release wiring is the v0.3 cut). The recipe is forward-looking and lands now per the issue's acceptance criteria; consumers can verify by browsing once v0.3 ships.Test plan
mkdocs build --strictpasses locallynpm run format:checkpassesnpm run lintpassesdocs/recipes/index.mdmkdocs.ymlexamples/docker-mode.ymlis a complete, runnable workflow (same snippet as the recipe)Closes #66