ci: add docs-sync workflow to auto-update bolt-docs on SDK PRs#65
Closed
RhysAtBolt wants to merge 2 commits intomainfrom
Closed
ci: add docs-sync workflow to auto-update bolt-docs on SDK PRs#65RhysAtBolt wants to merge 2 commits intomainfrom
RhysAtBolt wants to merge 2 commits intomainfrom
Conversation
Contributor
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Adds `.github/workflows/docs-sync.yml` and four supporting scripts in `.github/scripts/docs-sync/` — a non-blocking CI job that runs on every PR commit and uses GitHub Models (gpt-4o-mini) to keep the React Native SDK docs in bolt-docs in sync with SDK changes. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
de185c7 to
1441406
Compare
📝 Documentation Sync✅ The AI detected possible doc changes but no file differences were produced after applying the patch. RationaleThe changes in the pull request include modifications to public API types and interfaces, as well as updates to features such as Apple Pay and Google Pay. These updates directly impact the documentation, as they introduce new functionality and may change existing behavior that merchants need to be aware of. Last updated: commit |
arstiefel
approved these changes
Apr 23, 2026
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Author
|
Cancelling due to repo connection |
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
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.
Description
This PR adds a non-blocking CI workflow (
.github/workflows/docs-sync.yml) and four supporting scripts that automatically keep the React Native SDK documentation inBoltApp/bolt-docsin sync whenever a PR is opened or updated. The workflow uses a two-pass GitHub Models (gpt-4o-mini) analysis to determine whether documentation changes are needed and, if so, generates updated doc files and opens or updates a PR in bolt-docs. Comments are posted back to the SDK PR with a link to the docs PR, and deduplication via an HTML marker ensures repeated commits update the comment in-place rather than spamming the thread. The workflow is fully non-blocking (continue-on-error: true) and will never fail the SDK PR.Testing
No SDK source or test files were changed. End-to-end testing should be done manually by opening a PR that modifies a public interface (e.g. adds a prop to
BoltCheckoutProps) and verifying:sync-docsjob appears in PR checks and does not block the PR from merging<!-- bolt-docs-sync -->comment is posted on the SDK PR with a link to the docs PR or a rationaleBoltApp/bolt-docson branchreact-native-sdk-sync/pr-{N}Security Review
Important
A security review is required for every PR in this repository to comply with PCI requirements.
Security Impact Summary
This PR does not change any payment flows, user data handling, or authentication logic. It does introduce two token usages in CI:
GITHUB_TOKEN(built-in, scoped to this repo) for GitHub Models API calls and SDK PR operations, andDOCS_WRITE_TOKEN(an existing org PAT secret) for cross-repo read/write access toBoltApp/bolt-docs. The PAT is only used within the workflow runner environment and is not logged or exposed. No new secrets are created by this PR.