excalidraw-pages-deploy

name	excalidraw-pages-deploy
description	Use when: maintaining this repo's self-hosted Excalidraw GitHub Pages deployment, weekly upstream build workflow, gh-pages snapshot branch, excalidraw.x-ha.com domain docs, or custom font patching. Do not use when: the task is a generic code edit unrelated to Excalidraw, Pages, deployment, or fonts.
license	Proprietary
compatibility	Requires a modern Node.js runtime, git, GitHub Actions, network access for upstream Excalidraw, and current GitHub Pages permissions.
metadata	{"owner":"project-ai-maintainers","last-reviewed":"2026-06-27"}

Excalidraw Pages Deploy

Outcome

Maintain a reproducible static Excalidraw build that publishes to GitHub Pages for excalidraw.x-ha.com and preserves gh-pages as the static snapshot branch.

Workflow

1. Read AGENTS.md, README.md, docs/deployment/github-pages.md, docs/fonts/custom-fonts.md, and docs/ai/source-index.md.
2. Verify current upstream docs before changing Excalidraw build commands, GitHub Pages behavior, GitHub Actions versions, or local font-name assumptions.
3. Keep generated work under build/<task-name>/.
4. Update config/custom-fonts.json before editing font patch scripts.
5. When troubleshooting missing custom fonts, inspect the current upstream font picker and registry files before editing: packages/excalidraw/components/FontPicker/FontPickerList.tsx and packages/excalidraw/fonts/Fonts.ts.
6. Run node scripts/validate-config.mjs after changing workflow, docs, scripts, or font config.
7. If CI behavior changes, update .github/workflows/deploy-gh-pages.yml, deployment docs, and source index in the same change.

Gotchas

• GitHub currently documents that GITHUB_TOKEN commits do not trigger branch-based Pages builds. This repo pushes gh-pages over SSH using the DEPLOY_PAGE_KEY deploy key so Pages actually starts a build.
• The repository Pages source must be set to Deploy from a branch → gh-pages / root. Artifact-based deployment is no longer used.
• If Pages is not built after a green workflow run, verify the deploy key has Allow write access and that the secret contains the private key (not the public key) before changing Excalidraw build or font patching code.
• The workflow intentionally avoids hardcoded toolchain and action release version numbers. Use upstream Excalidraw compatibility metadata, Corepack, and official action default branch refs.
• Upstream Excalidraw source layout may change. Inspect the cloned files before changing regex patching logic.
• Current upstream font menu entries are rendered from Fonts.registered; adding constants and metadata alone does not make a font selectable.
• Do not download or redistribute font files. All custom fonts are local-only local(...) aliases.
• Do not invent unnamed artistic fonts. Require exact local font-family names.

Resources

• Read references/trigger-eval.md when editing this skill's trigger description.