Skip to content

fix: reuse stable branch for toolkit docs auto-PRs #1058

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
jottakka merged 2 commits into from
Jul 10, 2026
+11 −14
Merged

fix: reuse stable branch for toolkit docs auto-PRs #1058

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c087731
fix: reuse stable branch for toolkit docs auto-PRs
jottakka Jul 10, 2026
19216b3
fix: serialize toolkit docs PR updates
jottakka Jul 10, 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
2 changes: 1 addition & 1 deletion .github/workflows/generate-toolkit-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This workflow regenerates toolkit JSON and opens a PR with the changes. It can b
1. Builds the toolkit docs generator.
2. Generates toolkit JSON in `toolkit-docs-generator/data/toolkits` using the Engine tool metadata and summary endpoints.
3. Syncs integrations sidebar navigation from the generated JSON.
4. Creates a PR if any files changed.
4. Creates or updates a PR on the stable `automation/toolkit-docs` branch if any files changed. Later runs overwrite that open PR with the latest generated docs.

## Inputs and secrets

Expand Down
23 changes: 10 additions & 13 deletions .github/workflows/generate-toolkit-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ name: Generate toolkit docs
# 1) Build the toolkit docs generator
# 2) Generate toolkit JSON into toolkit-docs-generator/data/toolkits
# 3) Sync integrations sidebar _meta.tsx from toolkit-docs-generator/data/toolkits
# 4) Open a PR if changes were produced
# 4) Create or update a PR if changes were produced

on:
repository_dispatch:
Expand All @@ -18,6 +18,10 @@ permissions:
contents: write
pull-requests: write

concurrency:
group: generate-toolkit-docs
cancel-in-progress: true

jobs:
generate:
runs-on: ubuntu-latest
Expand Down Expand Up @@ -84,17 +88,7 @@ jobs:
- name: Sync toolkit sidebar navigation
run: pnpm dlx tsx toolkit-docs-generator/scripts/sync-toolkit-sidebar.ts --remove-empty-sections=false --verbose

- name: Check for changes
id: check-changes
run: |
if [ -n "$(git status --porcelain)" ]; then
echo "has_changes=true" >> $GITHUB_OUTPUT
else
echo "has_changes=false" >> $GITHUB_OUTPUT
fi

- name: Create pull request
if: steps.check-changes.outputs.has_changes == 'true'
id: cpr
uses: peter-evans/create-pull-request@v7
env:
Expand All @@ -110,11 +104,14 @@ jobs:
- Deploy env: ${{ github.event.client_payload.env || 'unknown' }}
- Deploy SHA: ${{ github.event.client_payload.deploy_sha || 'unknown' }}
- Run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
branch: automation/toolkit-docs-${{ github.run_id }}
# Stable branch so later runs update the open auto-PR instead of
# opening a new one each time. create-pull-request force-pushes the
# latest generated docs onto this branch.
branch: automation/toolkit-docs
delete-branch: true

- name: Request team review
if: steps.check-changes.outputs.has_changes == 'true' && steps.cpr.outputs.pull-request-number != ''
if: steps.cpr.outputs.pull-request-number != ''
continue-on-error: true
run: gh pr edit ${{ steps.cpr.outputs.pull-request-number }} --add-reviewer ArcadeAI/engineering-tools-and-dx
env:
Expand Down
Loading