Skip to content

docs: handle PR permission restrictions in sync workflow#161

Merged
ben-fornefeld merged 2 commits intomainfrom
fix/sdk-reference-sync-pr-permissions
Mar 17, 2026
Merged

docs: handle PR permission restrictions in sync workflow#161
ben-fornefeld merged 2 commits intomainfrom
fix/sdk-reference-sync-pr-permissions

Conversation

@ben-fornefeld
Copy link
Copy Markdown
Member

@ben-fornefeld ben-fornefeld commented Mar 17, 2026

Summary

  • handle repositories where GitHub Actions cannot create pull requests with github.token
  • support an optional SDK_REFERENCE_SYNC_PR_TOKEN secret for PR creation
  • fall back to a manual compare URL and summary note instead of failing the workflow

Testing

  • bash -n scripts/create-sdk-reference-sync-pr.sh

Note

Medium Risk
Changes the SDK reference sync workflow’s authentication and PR-creation mechanism, which could break the automation if the GitHub App token/permissions are misconfigured. Scope is limited to CI workflow behavior (no runtime/product code).

Overview
The SDK reference sync workflow now authenticates using a GitHub App installation token (via actions/create-github-app-token) and uses peter-evans/create-pull-request to commit generated docs changes and create/update the PR.

This removes the custom scripts/create-sdk-reference-sync-pr.sh + gh-CLI flow, updates checkout to use the app token, and adjusts summary outputs to the new action’s pull-request-* fields.

Written by Cursor Bugbot for commit 71e91a6. This will update automatically on new commits. Configure here.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Comment thread scripts/create-sdk-reference-sync-pr.sh Outdated
Copy link
Copy Markdown
Contributor

@matthewlouisbrockman matthewlouisbrockman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

peter evans looked sus but is real

@ben-fornefeld ben-fornefeld merged commit da5f120 into main Mar 17, 2026
7 of 8 checks passed
@ben-fornefeld ben-fornefeld deleted the fix/sdk-reference-sync-pr-permissions branch March 17, 2026 19:40
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