eblume/blumeops
1
1
Fork 0
Code Issues Pull requests Projects Releases 83 Packages Wiki Activity Actions
blumeops/docs/reference/services/docs.md
Erich Blume b197bd5f58 Adopt Dagger CI for docs build (Phase 2) (#157) 
## Summary

Migrates the docs build pipeline to Dagger (Phase 2 of the Dagger CI adoption plan).

- **Backfill `date-modified` frontmatter** on all 80 docs — Dagger's `--src=.` excludes `.git`, so Quartz can't use git history for page dates. Frontmatter dates work with or without git.
- **New `docs-check-frontmatter` mise task + pre-commit hook** — validates all docs have `title`, `tags`, and `date-modified`
- **New Dagger functions** — `build_changelog` (towncrier in Python container) and `build_docs` (chains changelog → Quartz build in Node container, returns tarball)
- **Simplified CI workflow** — the ~44-line inline Quartz build (clone, npm ci, build, tar, cleanup) is replaced by `dagger call build-docs`. Changelog step remains local on the runner since towncrier needs to modify the host working tree for the git commit.

### Design decisions

- **Towncrier runs twice in CI**: once inside Dagger (for the docs tarball) and once on the runner (for the git commit). This is intentional — Dagger's directory export is additive and can't delete the consumed changelog fragments from the host.
- **Artifact hosting stays on Forgejo Releases** (not migrated to Forgejo Packages as the plan doc originally suggested). That migration can happen independently.
- **`date-modified` frontmatter** preserved even though `build_changelog` installs git — the git there is only for towncrier's `git add` call, not for history. The local iteration story (`dagger call build-docs --src=. --version=dev` with uncommitted changes) depends on frontmatter dates.

### Local iteration

```bash
dagger call build-docs --src=. --version=dev export --path=./docs-dev.tar.gz
tar tf docs-dev.tar.gz | head -20
```

## Deployment and Testing

- [x] `dagger call build-docs --src=. --version=dev` produces valid 1.1MB tarball (149 HTML pages)
- [x] Pre-commit hooks pass (including new `docs-check-frontmatter`)
- [ ] Full `workflow_dispatch` run after merge

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Reviewed-on: https://forge.ops.eblu.me/eblume/blumeops/pulls/157
2026-02-11 16:33:16 -08:00

1.5 KiB
Raw Blame History

title date-modified tags
Docs 2026-02-08
service
documentation

Docs (Quartz)

Documentation site built with Quartz and served via nginx.

Quick Reference

Property Value
Public URL https://docs.eblu.me
Private URL docs.ops.eblu.me (tailnet only, via caddy)
Namespace docs
Container registry.ops.eblu.me/blumeops/quartz:v1.0.0
Source docs/ directory in blumeops repo
Build Forgejo workflow build-blumeops.yaml
Public proxy flyio-proxy (Fly.io → Tailscale tunnel)

Architecture

  1. Source: Markdown files in docs/ with Obsidian-compatible wiki-links
  2. Build: Forgejo workflow builds Quartz static site on push to main
  3. Release: Built assets published as Forgejo release attachments
  4. Deploy: Container downloads release bundle on startup, serves via nginx

Release Process

Documentation is automatically built and released when changes are pushed to main:

  1. Workflow detects changes in docs/ directory
  2. Quartz builds static HTML/CSS/JS
  3. Assets uploaded as release attachment
  4. ArgoCD deployment updated with new DOCS_RELEASE_URL
  5. Pod restarts and downloads new bundle

Configuration

  • Quartz config: quartz.config.ts
  • Layout: quartz.layout.ts
  • ArgoCD app: argocd/apps/docs.yaml
  • Manifests: argocd/manifests/docs/

Related