Conversation
- Resolved merge conflicts in .rhiza/make.d/README.md and docs/index.md - Removed orphaned files (docs.mk, semgrep.yml, old docs pages) - Added new files: book.mk, rhiza_book.yml, docs structure, .github/semgrep.yml Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Remove orphaned files no longer tracked by the template: - .github/ISSUE_TEMPLATE/config.yml - docs/guides/EXTENDING_RHIZA.md - docs/guides/QUICK_REFERENCE.md - docs/reference/ARCHITECTURE.md - docs/reference/DEPENDENCIES.md - docs/reference/GLOSSARY.md - docs/reference/SHELL_SCRIPTS.md - docs/reference/TOOLS_REFERENCE.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Update .rhiza/template.yml ref from v0.9.5 to v0.10.1 - Accept rhiza template versions for workflow/make files - Accept main versions for project content (docs/index.md, docs/mkdocs-base.yml) - Accept main's deletion of .rhiza/docs/, .rhiza/make.d/README.md, .rhiza/tests/integration/test_docs_targets.py Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Bumps the Rhiza template reference to v0.10.1 and brings the repository’s Rhiza-managed Make/workflow plumbing in line with the updated template, including updates to CI and GitHub Pages documentation deployment.
Changes:
- Update
.rhiza/template.ymlto track Rhiza templatev0.10.1. - Revise book build targets to be MkDocs-based and adjust generated docs artifacts (reports/notebooks).
- Extend CI with a kaleido test job and add a coverage-badge publishing job; migrate Pages deploy to
actions/deploy-pages.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
docs/adr/0000-adr-template.md |
Adds an ADR template document for consistent decision records. |
.rhiza/template.yml |
Bumps the Rhiza template ref to v0.10.1. |
.rhiza/make.d/book.mk |
Reworks book build targets toward MkDocs and adjusts report/notebook generation. |
.github/workflows/rhiza_ci.yml |
Adds kaleido testing and a coverage-badge publishing job. |
.github/workflows/rhiza_book.yml |
Switches GitHub Pages deployment to the official Pages artifact/deploy actions. |
| for nb in $(MARIMO_FOLDER)/*.py; do \ | ||
| [ -f "$$nb" ] || continue; \ | ||
| name=$$(basename "$$nb" .py); \ | ||
| printf "${BLUE}[INFO] Exporting $$nb${RESET}\n"; \ | ||
| abs_output="$$(pwd)/docs/notebooks/$$name.html"; \ | ||
| mkdir -p docs/notebooks; \ | ||
| (cd "$$(dirname "$$nb")" && ${UV_BIN} run marimo export html --sandbox "$$(basename "$$nb")" -o "$$abs_output"); \ | ||
| done; \ | ||
| printf -- "---\nicon: lucide/book-open\n---\n\n# Marimo Notebooks\n\n" > docs/notebooks.md; \ | ||
| printf "# Marimo Notebooks\n\n" > docs/notebooks.md; \ | ||
| for html in docs/notebooks/*.html; do \ | ||
| [ -f "$$html" ] || continue; \ | ||
| name=$$(basename "$$html" .html); \ | ||
| echo "- [$$name](notebooks/$$name.html)" >> docs/notebooks.md; \ | ||
| echo "- [$$name]($$name.html)" >> docs/notebooks.md; \ | ||
| done; \ |
There was a problem hiding this comment.
In _book-notebooks, the loops over $(MARIMO_FOLDER)/*.py and docs/notebooks/*.html no longer guard against unmatched globs. If there are no .py notebooks (or no exported .html files), the glob pattern will be passed through literally and marimo export/basename will run on a non-existent file, causing make book to fail. Restore a -f/-e check (or enable nullglob) and continue when no matches.
| [ -f "$$html" ] || continue; \ | ||
| name=$$(basename "$$html" .html); \ | ||
| echo "- [$$name](notebooks/$$name.html)" >> docs/notebooks.md; \ | ||
| echo "- [$$name]($$name.html)" >> docs/notebooks.md; \ |
There was a problem hiding this comment.
docs/notebooks.md is generated at docs/, but the exported notebook HTML files are written under docs/notebooks/. The generated link ($$name.html) will therefore point to a non-existent file; it should link into the notebooks/ subdirectory.
| echo "- [$$name]($$name.html)" >> docs/notebooks.md; \ | |
| echo "- [$$name](notebooks/$$name.html)" >> docs/notebooks.md; \ |
| @mkdir -p "$(BOOK_OUTPUT)" | ||
| @touch "$(BOOK_OUTPUT)/.nojekyll" | ||
| @printf "${GREEN}[SUCCESS] Book built at $(BOOK_OUTPUT)/${RESET}\n" | ||
| @tree $(BOOK_OUTPUT) |
There was a problem hiding this comment.
The book target unconditionally runs tree $(BOOK_OUTPUT). tree is not guaranteed to be installed on CI runners or developer machines, so this can make make book fail even when the MkDocs build succeeded. Consider guarding it with command -v tree (or using a more portable find/ls fallback).
| @tree $(BOOK_OUTPUT) | |
| @if command -v tree >/dev/null 2>&1; then \ | |
| tree "$(BOOK_OUTPUT)"; \ | |
| else \ | |
| find "$(BOOK_OUTPUT)" -print; \ | |
| fi |
| book:: _book-reports _book-notebooks ## compile the companion book via MkDocs | ||
| @if [ -n "$(_MKDOCS_CFG)" ]; then \ | ||
| rm -rf "$(BOOK_OUTPUT)"; \ | ||
| ${UVX_BIN} --with "mkdocs-material<10.0" --with "pymdown-extensions>=10.0" --with "mkdocs<2.0" $(MKDOCS_EXTRA_PACKAGES) mkdocs build \ | ||
| -f "$(_MKDOCS_CFG)" \ |
There was a problem hiding this comment.
book:: invokes ${UVX_BIN} ... mkdocs build but does not depend on install-uv (unlike mkdocs-build / mkdocs-serve). This can cause make book to fail in a fresh environment where uvx isn't installed yet. Add install-uv (or install) as a prerequisite for book to make it self-contained.
| github_token: ${{ secrets.GH_PAT || github.token }} | ||
| publish_dir: ./_book | ||
| uses: actions/deploy-pages@v5.0.0 # Official GitHub Pages deployment action | ||
| continue-on-error: true |
There was a problem hiding this comment.
The GitHub Pages deployment step sets continue-on-error: true, which will make the workflow pass even if the Pages deploy fails. That can silently leave Pages stale while CI appears green. Consider removing continue-on-error (or turning it into a conditional retry) so deployment failures are visible.
| continue-on-error: true |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Summary
.rhiza/template.ymlref fromv0.9.5tov0.10.1mainchanges into the rhiza sync branch.github/workflows/rhiza_book.yml,rhiza_ci.yml,.rhiza/make.d/book.mk): kept rhiza template version (HEAD)docs/index.md,docs/mkdocs-base.yml): kept main versionexcludelist (.rhiza/docs/,.rhiza/make.d/README.md,test_docs_targets.py): accepted deletionsTest plan
🤖 Generated with Claude Code