ci: notify help-docs hub on docs changes
Adds a tiny workflow that, when a PR touching docs merges to the default branch, notifies the help-docs hub (repository_dispatch) so the change is promoted up into help-docs as a review PR.
Part of the bidirectional docs-sync (help-docs is the source-of-truth hub). See tools/DOCS_SYNC.md in help-docs.
Requires the shared docs-sync GitHub App and these repo (or org-level) Actions secrets:
DOCS_SYNC_APP_IDDOCS_SYNC_APP_PRIVATE_KEY
The job skips with a notice if they're unset, and skips sync-generated merges (marker [docs-sync], checked across every commit in the push) so it never loops.
Merge order: help-docs #43 must merge first β it lands the promote-from-product handler on help-docs' default branch. Until then a dispatch has no consumer (returns 204 and does nothing).
π€ Generated with Claude Code
Summary by cubic
Add a workflow that notifies the help-docs hub when docs change on main, promoting a review PR. It sends before/after SHAs and source PR info; skips [docs-sync] commits (checks all commit messages); adds a config gate; builds the payload with jq; runs on ubuntu-latest with a short timeout; is push-only; and pins the GitHub App token action to v2 with the token scoped to contents: write.
- Migration
- Install the shared docs-sync GitHub App.
- Add
DOCS_SYNC_APP_IDandDOCS_SYNC_APP_PRIVATE_KEYas repo secrets.
Summary by CodeRabbit
- Chores
- Added automated notifications to the documentation repository when documentation updates are pushed to the main branch.
- Included source change and pull request details to support accurate documentation updates.
- Added support for manually triggering documentation update notifications.
- Prevented notification loops for commits marked as documentation synchronization updates.
- Added safeguards to skip notifications when required configuration is unavailable.