Add internal→public docs promotion pipeline - #6
Open
VeronicaSnyk wants to merge 1 commit into
Open
Conversation
Scaffolds the staging→prod promotion the AI ContentOps roadmap calls for: this internal repo is the source of truth (content + kitchen); the public snyk/user-docs repo is a content-only frontend gate. - promote/promote-to-public.sh — mirrors canonical ROOT sections (docs/<section> → public /<section>), opens a reviewable PR, never merges. - promote/ingest-from-public.sh — seeds/refreshes internal docs from public ROOT sections, skipping the GitBook-owned docs/ folder. - .github/workflows/promote-to-public.yml — runs promotion on push to main, gated by Vale + link/summary/image checks, then opens the PR. Both directions protect the public docs/ tree (GitBook Git Sync territory) and exclude tools/ (synced Go infra). Validated end-to-end against snyk/user-docs in --dry-run: no GitBook plumbing leak, docs/ untouched, gate scripts pass. Co-Authored-By: Claude Opus 4.8 (1M context) <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
1 participant
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 this adds
Scaffolds the staging→prod promotion the AI ContentOps roadmap calls for: this internal repo is the source of truth (docs content + the internal kitchen — skills, scripts, workflows); the public
snyk/user-docsrepo is a content-only frontend gate.Files
promote/promote-to-public.shdocs/<section>→ public/<section>), opens a reviewable PR, never merges.promote/ingest-from-public.shdocs/folder..github/workflows/promote-to-public.ymlmain, gated by Vale + link/summary/image checks, then opens the PR.promote/README.mdSafety properties (validated end-to-end against
snyk/user-docsin--dry-run)docs/is never touched — it's GitBook Git Sync territory. Protected via rsync--filter protectand by syncing only named sections. Verified:docs/,.gitbook.yaml,SUMMARY.mdsurvive untouched.tools/excluded — synced Go infra (api-docs-generator), not content.Canonical-tree decision
Confirmed with evidence that the root sections are canonical (not the
docs/folder): the error-catalog sync workflow writes to a root path; rootdiscover-snykhas 178 files vsdocs/'s 37; root content is fresher (2026-07-06 vs 2026-06-11).Not yet live
Does not run until: (1)
PUBLIC_DOCS_REPOvariable set, (2)PUBLIC_DOCS_PUSH_TOKENsecret added, (3) real target chosen. On a feature-branch PR the workflow does not execute. Nothing has touchedsnyk/user-docs.🤖 Generated with Claude Code