feat: auto-sync docs/ to compass-docs on push#1712
Merged
tyler-dane merged 2 commits intomainfrom May 4, 2026
Merged
Conversation
Triggers on push to main when any docs/** file changes (plus workflow_dispatch for manual runs). Rsyncs the docs/ directory to the compass-docs repo and pushes a commit, which triggers a Vercel deployment automatically. Requires a repo secret COMPASS_DOCS_TOKEN: a fine-grained PAT with Contents read+write scoped to SwitchbackTech/compass-docs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Adds
.github/workflows/sync-docs.yml— a GitHub Action that keeps the compass-docs site in sync with this repo'sdocs/directory automatically.How it works
mainthat touchesdocs/**(plusworkflow_dispatchfor manual runs)compass-docsrsync --deletecopiesdocs/→compass-docs/docs/, mirroring the folder structure exactlycompass-docsonly if something changeddocs.compasscalendar.comBefore merging
A repository secret must exist in this repo:
COMPASS_DOCS_TOKENSwitchbackTech/compass-docsTest plan
COMPASS_DOCS_TOKENsecret is set in this repo's Actions secretssync-docsmanually via Actions → workflow_dispatchdocs/→ push to main → confirm end-to-end flow completes🤖 Generated with Claude Code