Skip to content

ci(docs): dispatch docs rebuild to lockfamily, nav.toml rule (#200) - #202

Merged
DavidGodefroid merged 1 commit into
mainfrom
ci/200-docs-dispatch
Nov 14, 2026
Merged

DavidGodefroid merged 1 commit into
mainfrom
ci/200-docs-dispatch

Conversation

@DavidGodefroid

Copy link
Copy Markdown
Owner

Closes #200.

What

  • .github/workflows/docs-dispatch.yml: on a push to main touching README.md, CHANGELOG.md, GUIDE.md or docs/**, and on a published release, sends repository_dispatch (type docs) to DavidGodefroid/lockfamily, whose pages workflow rebuilds lockfamily.dev/docs. permissions: {}; uses no third-party action (only gh on the runner), so nothing to pin.
  • Without the LOCKFAMILY_DOCS_TOKEN secret, the step prints ::notice::LOCKFAMILY_DOCS_TOKEN not set and exits 0; the nightly build still picks the change up.
  • README "Contributing" section: the nav.toml rule (new docs/ file or renamed/removed README H2 needs a lockfamily docs-site/nav.toml PR). The repo has no PR template, so no checkbox (per the issue: "With a PR template").

Owner action

Create the fine-grained token (lockfamily only, Contents read/write) and set it as LOCKFAMILY_DOCS_TOKEN here (lockfamily#39). Until then the workflow passes with the notice.

🤖 Generated with Claude Code

Send a repository_dispatch (type docs) to lockfamily on a push to main touching README/CHANGELOG/GUIDE/docs, and on a published release, so lockfamily.dev/docs shows the change within minutes. Without the LOCKFAMILY_DOCS_TOKEN secret the job passes with a notice. README's contributing section states the nav.toml rule.

Closes #200

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@DavidGodefroid
DavidGodefroid merged commit 7fdb89a into main Nov 14, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs site: send a docs dispatch to lockfamily, and the nav.toml rule

1 participant