feat(docs-dev): add DocsDev image for the 415-docs review environment - #1
Merged
Conversation
Bundles the toolchain that cmput415/415-docs's CI workflows and .agents/ scaffold expect: Sphinx + latexmk + texlive (deploySite.yml), lychee (linkcheck.yml), uv (pyproject-managed venv), act (local workflow replay), plus graphviz and gnupg. Published under ghcr.io/cmput415/docs-dev via a workflow that mirrors the existing GazUtils/ANTLR/LLVM/DragonRunner build-and-push pattern. Requested in review on cmput415/415-docs#110 -- lets the .agents/ scaffold there point at a maintained image instead of a bash bootstrap script per session. Assisted-by: Agent (claude) <ai@blobfish.icu>
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
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
Adds a new top-level
DocsDev/directory with a Dockerfile that bundlesthe toolchain
cmput415/415-docsneeds for local docs builds and spec-review sessions:
latexmk+texlive-latex-extra(matchesdeploySite.yml)lychee(matcheslinkcheck.yml)uv(Astral) for thepyproject.tomlvenvact— run the docs repo's GitHub Actions locallygraphviz,gnupg,jqPublished as
ghcr.io/cmput415/docs-dev:{date,latest}via a workflow thatmirrors the existing GazUtils / ANTLR / LLVM / DragonRunner build-and-push
pattern (
.github/workflows/docs-dev.yml).Why
Requested in review on cmput415/415-docs#110 — the
.agents/scaffoldthere is being simplified to point at a maintained image instead of
provisioning the environment via a bash bootstrap script per session.
Agents (and humans) can
docker runand get every tool the CI workflowsand the
.agents/scaffold expect on PATH, no host apt work required.Test plan
docker build ./DocsDevbuilds cleanly on the self-hosted runner.uv --version,sphinx-build --version,lychee --version,act --version,latexmk --version,dot -Vall report successfully.
docker run --rm -v \$PWD:/workspace ghcr.io/cmput415/docs-dev:latest \\ bash -c 'uv sync && make -C gazprea html'succeeds in a checkoutof 415-docs.
docs-dev.ymlworkflow tags and pushes both:latestand thedate tag to ghcr.io on merge to
main.🤖 Generated with Claude Code