Skip to content

chore: apply rhiza sync v1.8.0 #315

chore: apply rhiza sync v1.8.0

chore: apply rhiza sync v1.8.0 #315

Workflow file for this run

# This file is part of the jebel-quant/rhiza repository
# (https://github.com/jebel-quant/rhiza).
#
# Workflow: Book
# Purpose: This workflow builds and deploys comprehensive documentation for the project.
# It combines API documentation, test coverage reports, test results, and
# interactive notebooks into a single GitHub Pages site.
#
# Trigger: This workflow runs on every push (any branch), so every commit
# validates that the book still builds. The reusable workflow deploys
# to GitHub Pages only from the repository's default branch and never
# from a fork; other branches build and upload an artifact only.
#
# Components:
# - 📓 Process Marimo notebooks
# - 📖 Build documentation site via zensical
# - 🧪 Run tests and generate coverage reports
# - 🚀 Deploy combined documentation to GitHub Pages
name: "(RHIZA) BOOK"
on:
push:
branches:
- '**'
permissions:
contents: read
jobs:
book:
uses: jebel-quant/rhiza/.github/workflows/rhiza_book.yml@v1.8.0
secrets: inherit
permissions:
contents: read
pages: write
id-token: write
# Set `deploy-pages: false` for artifact-only mode -- the reusable workflow
# still uploads the generic `book` artifact, and a consumer-owned job below
# can download it and deploy to Cloudflare Pages, Azure Static Web Apps,
# S3/CloudFront, an internal web server, etc. See docs/guides/BOOK.md for a
# full Cloudflare Pages example.
# with:
# deploy-pages: false