Skip to content

docs: handle PR permission restrictions in sync workflow #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ben-fornefeld merged 2 commits into from
Mar 17, 2026
Merged

docs: handle PR permission restrictions in sync workflow #161

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d1e632
docs: handle PR permission restrictions in sync workflow
ben-fornefeld Mar 17, 2026
71e91a6
docs: use GitHub App token for sdk sync PRs
ben-fornefeld Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion .github/workflows/sdk-reference-sync.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,8 @@ jobs:
if: steps.changes.outputs.changes == 'true'
id: pr
env:
GH_TOKEN: ${{ github.token }}
GH_TOKEN: ${{ secrets.SDK_REFERENCE_SYNC_PR_TOKEN != '' && secrets.SDK_REFERENCE_SYNC_PR_TOKEN || github.token }}
TOKEN_SOURCE: ${{ secrets.SDK_REFERENCE_SYNC_PR_TOKEN != '' && 'SDK_REFERENCE_SYNC_PR_TOKEN' || 'github.token' }}
BASE_BRANCH: ${{ github.ref_name }}
BRANCH_NAME: automation/sdk-reference-sync
TRIGGER: ${{ steps.params.outputs.trigger }}
Expand Down Expand Up @@ -179,6 +180,12 @@ jobs:
fi
echo "" >> $GITHUB_STEP_SUMMARY

if [[ "$PR_OPERATION" == "manual" ]]; then
echo "Automatic PR creation is blocked for \`github.token\` in this repository." >> $GITHUB_STEP_SUMMARY
echo "Enable the repository setting 'Allow GitHub Actions to create and approve pull requests' or add the \`SDK_REFERENCE_SYNC_PR_TOKEN\` secret for this workflow." >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
fi

if [[ "$CHANGES" == "true" ]]; then
echo "### Generated Files" >> $GITHUB_STEP_SUMMARY
echo '```' >> $GITHUB_STEP_SUMMARY
Expand Down
23 changes: 18 additions & 5 deletions scripts/create-sdk-reference-sync-pr.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ force="${FORCE:-false}"
changed_files="${CHANGED_FILES:-0}"
total_mdx_files="${TOTAL_MDX_FILES:-0}"
workflow_name="${WORKFLOW_NAME:-}"
repository="${REPOSITORY:-}"
run_id="${RUN_ID:-}"
repository="${REPOSITORY:?REPOSITORY is required}"
run_id="${RUN_ID:?RUN_ID is required}"
token_source="${TOKEN_SOURCE:-github.token}"

if [[ "$base_branch" == "$branch_name" ]]; then
echo "Base branch and PR branch cannot be the same" >&2
Expand All @@ -45,6 +46,7 @@ if git diff --staged --quiet; then
fi

title="docs: sync SDK reference for ${sdk_name} ${sdk_version}"
compare_url="https://github.com/${repository}/compare/${base_branch}...${branch_name}?expand=1"

git commit -m "$title"
git push --force-with-lease origin "HEAD:${branch_name}"
Expand Down Expand Up @@ -88,13 +90,24 @@ if [[ -n "$pr_info" ]]; then
gh pr edit "$pr_number" --repo "$repository" --title "$title" --body-file "$body_file" >/dev/null
operation="updated"
else
pr_url="$(gh pr create \
if ! pr_url="$(gh pr create \
--repo "$repository" \
--base "$base_branch" \
--head "$branch_name" \
--title "$title" \
--body-file "$body_file")"
operation="created"
--body-file "$body_file" 2>&1)"; then
Comment thread
cursor[bot] marked this conversation as resolved.
Outdated
if [[ "$token_source" == "github.token" ]] && [[ "$pr_url" == *"GitHub Actions is not permitted to create or approve pull requests"* ]]; then
echo "Automatic PR creation is blocked for github.token in this repository." >&2
echo "Enable the repository setting 'Allow GitHub Actions to create and approve pull requests' or configure the SDK_REFERENCE_SYNC_PR_TOKEN secret." >&2
pr_url="$compare_url"
operation="manual"
else
echo "$pr_url" >&2
exit 1
fi
else
operation="created"
fi
fi

{
Expand Down
Loading