Skip to content

ci: add docs-sync workflow to auto-update bolt-docs on SDK PRs#65

Closed
RhysAtBolt wants to merge 2 commits intomainfrom
ci/docs-sync-workflow
Closed

ci: add docs-sync workflow to auto-update bolt-docs on SDK PRs#65
RhysAtBolt wants to merge 2 commits intomainfrom
ci/docs-sync-workflow

Conversation

@RhysAtBolt
Copy link
Copy Markdown
Contributor

@RhysAtBolt RhysAtBolt commented Apr 23, 2026

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 in BoltApp/bolt-docs in 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:

  • The sync-docs job appears in PR checks and does not block the PR from merging
  • A <!-- bolt-docs-sync --> comment is posted on the SDK PR with a link to the docs PR or a rationale
  • A PR is opened in BoltApp/bolt-docs on branch react-native-sdk-sync/pr-{N}
  • Subsequent commits to the same PR update the existing docs PR rather than creating a new one
  • An internal-only change (e.g. test file, build config) results in a "no update required" comment

Security Review

Important

A security review is required for every PR in this repository to comply with PCI requirements.

  • I have considered and reviewed security implications of this PR and included the summary below.

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, and DOCS_WRITE_TOKEN (an existing org PAT secret) for cross-repo read/write access to BoltApp/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.

@RhysAtBolt RhysAtBolt requested review from a team as code owners April 23, 2026 19:22
@snyk-io
Copy link
Copy Markdown
Contributor

snyk-io Bot commented Apr 23, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 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>
@RhysAtBolt RhysAtBolt force-pushed the ci/docs-sync-workflow branch from de185c7 to 1441406 Compare April 23, 2026 19:25
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 23, 2026

📝 Documentation Sync

✅ The AI detected possible doc changes but no file differences were produced after applying the patch.

Rationale

The 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 484ee3b

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@RhysAtBolt
Copy link
Copy Markdown
Contributor Author

Cancelling due to repo connection

@RhysAtBolt RhysAtBolt closed this Apr 24, 2026
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.

2 participants