Erich Blume
779b7d6709
## Summary - Added a new `build_quartz` Dagger function that builds the Quartz site from a pre-processed source tree (no towncrier) - Reordered the release workflow so towncrier runs **once** on the runner, then passes the updated working tree to `build-quartz` - `build_docs` and `build_changelog` are preserved for standalone use — `build_docs` now delegates to `build_quartz` internally ## Motivation Previously towncrier ran twice per release: once inside a Dagger container (via `build_docs` → `build_changelog`) and once on the runner to capture CHANGELOG.md changes for the git commit. This was wasteful and fragile — if towncrier behavior changed, the two runs could produce different results. ## Test plan - [ ] Review diff to confirm workflow step ordering is correct - [ ] Trigger a release and confirm towncrier runs only once - [ ] Verify the docs tarball contains the updated CHANGELOG.md - [ ] `dagger call build-quartz --src=. --version=vX.Y.Z` should work standalone Reviewed-on: https://forge.ops.eblu.me/eblume/blumeops/pulls/199
123 lines
3.9 KiB
Markdown
123 lines
3.9 KiB
Markdown
---
|
|
title: Update Documentation
|
|
modified: 2026-02-08
|
|
tags:
|
|
- how-to
|
|
- documentation
|
|
- ci-cd
|
|
---
|
|
|
|
# Update Documentation
|
|
|
|
How to publish documentation changes to https://docs.eblu.me.
|
|
|
|
## Quick Release
|
|
|
|
After merging documentation changes to main:
|
|
|
|
1. Go to **Actions** > **Build BlumeOps** > **Run workflow**
|
|
2. Select version bump type (patch/minor/major) or enter a specific version
|
|
3. The workflow builds, releases, and deploys automatically
|
|
|
|
Direct link: https://forge.ops.eblu.me/eblume/blumeops/actions?workflow=build-blumeops.yaml
|
|
|
|
## What the Workflow Does
|
|
|
|
The `build-blumeops` workflow (`.forgejo/workflows/build-blumeops.yaml`):
|
|
|
|
1. **Resolves version** — Uses input or auto-increments from latest release
|
|
2. **Builds changelog** — Runs towncrier on the runner to update `CHANGELOG.md`
|
|
3. **Builds docs** — Calls `dagger call build-docs` (Quartz build in a container)
|
|
4. **Creates release** — Uploads `docs-<version>.tar.gz` to Forgejo releases
|
|
5. **Updates deployment** — Edits `argocd/manifests/docs/deployment.yaml` with new URL
|
|
6. **Commits changes** — Pushes changelog and deployment updates to main
|
|
7. **Deploys** — Syncs the `docs` ArgoCD app
|
|
|
|
## Changelog Fragments (Towncrier)
|
|
|
|
When making changes, add a changelog fragment to `docs/changelog.d/`:
|
|
|
|
```bash
|
|
# Format: <identifier>.<type>.md
|
|
# Types: feature, bugfix, infra, doc, ai, misc
|
|
|
|
# Using branch name (preferred)
|
|
echo "Add new feature X" > docs/changelog.d/my-feature.feature.md
|
|
|
|
# Orphan fragment (when no branch fits)
|
|
echo "Fix bug Y" > docs/changelog.d/+fix-bug.bugfix.md
|
|
```
|
|
|
|
Fragments are automatically collected into `CHANGELOG.md` (at repo root) during release.
|
|
|
|
**Fragment types:**
|
|
| Type | Directory | Description |
|
|
|------|-----------|-------------|
|
|
| `feature` | `feature/` | New features |
|
|
| `bugfix` | `bugfix/` | Bug fixes |
|
|
| `infra` | `infra/` | Infrastructure changes |
|
|
| `doc` | `doc/` | Documentation updates |
|
|
| `ai` | `ai/` | AI assistance changes |
|
|
| `misc` | `misc/` | Other changes |
|
|
|
|
## Runner Environment
|
|
|
|
The workflow runs on the `k8s` label, which uses the [[forgejo]]-runner in Kubernetes:
|
|
|
|
- **Runner deployment**: `argocd/manifests/forgejo-runner/`
|
|
- **Job image**: `registry.ops.eblu.me/blumeops/forgejo-runner:latest`
|
|
- **Build engine**: [[dagger]] CLI installed at runtime; Node.js and Python run inside Dagger containers
|
|
|
|
The job image is built from `containers/forgejo-runner/Dockerfile`.
|
|
|
|
## Quartz Static Site Generator
|
|
|
|
[Quartz](https://quartz.jzhao.xyz/) builds the documentation into a static site with:
|
|
- Wiki-link support (`[[page]]` syntax)
|
|
- Backlinks panel showing what references each page
|
|
- Graph view of document connections
|
|
- Full-text search
|
|
|
|
**Configuration files** (in `docs/`):
|
|
- `quartz.config.ts` - Site metadata, plugins, theme
|
|
- `quartz.layout.ts` - Page layout components
|
|
|
|
Quartz is cloned fresh during each build (not vendored) to use the latest version.
|
|
|
|
## Manual Build (Local)
|
|
|
|
To test docs locally without triggering a release:
|
|
|
|
```bash
|
|
# Build docs tarball (identical to CI)
|
|
dagger call build-docs --src=. --version=dev export --path=./docs-dev.tar.gz
|
|
|
|
# Inspect the output
|
|
tar tf docs-dev.tar.gz | head -20
|
|
|
|
# Debug a Quartz build failure interactively
|
|
dagger call --interactive build-docs --src=. --version=dev
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
**Workflow fails on "Resolve version":**
|
|
- Check if the version already exists as a release
|
|
- Ensure version format is `vX.Y.Z`
|
|
|
|
**Docs not updating after deploy:**
|
|
- Check ArgoCD sync status: `argocd app get docs`
|
|
- Verify the pod restarted: `kubectl --context=minikube-indri -n docs get pods`
|
|
- Check pod logs for download errors
|
|
|
|
**Towncrier not finding fragments:**
|
|
- Fragments must be in `docs/changelog.d/`
|
|
- Must have `.md` extension
|
|
- Must match pattern `<name>.<type>.md`
|
|
|
|
## Related
|
|
|
|
- [[docs]] - Documentation service reference
|
|
- [[dagger]] - Build engine reference
|
|
- [[forgejo]] - Git forge and CI/CD
|
|
- [[argocd]] - GitOps deployment
|