Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 22, 03:15 UTC
feat: add workflow to sync docs guides on SDK source changes
When SDK source code changes land on next, Claude reviews the diff and updates any guides, FAQs, or examples that reference the changed APIs. Auto-generated reference pages are handled separately. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sushmitha Mallesh committed
Mar 13, 2026 at 17:39 UTC
9aa5ac0b9442eb19a7371f94b2b0cd1c05503d30
1 file changed
+96
.github/workflows/docs.sdk-change-sync.yml
new
+96
@@ -0,0 +1,96 @@
1
+name: Docs - Sync guides on SDK changes
2
+
3
+on:
4
+ push:
5
+ branches: [next]
6
+ paths:
7
+ - 'ts/packages/core/src/**'
8
+ - 'ts/packages/cli/src/**'
9
+ - 'ts/packages/providers/*/src/**'
10
+ - 'python/composio/**'
11
+
12
+jobs:
13
+ sync-docs:
14
+ runs-on: ubuntu-latest
15
+ timeout-minutes: 30
16
+ permissions:
17
+ contents: write
18
+ pull-requests: write
19
+ id-token: write
20
+
21
+ steps:
22
+ - name: Checkout repository
23
+ uses: actions/checkout@v6
24
+ with:
25
+ fetch-depth: 2
26
+
27
+ - name: Get SDK diff
28
+ id: diff
29
+ run: |
30
+ DIFF=$(git diff HEAD~1 -- \
31
+ ts/packages/core/src/ \
32
+ ts/packages/cli/src/ \
33
+ ts/packages/providers/*/src/ \
34
+ python/composio/)
35
+
36
+ if [ -z "$DIFF" ]; then
37
+ echo "has_changes=false" >> $GITHUB_OUTPUT
38
+ else
39
+ echo "has_changes=true" >> $GITHUB_OUTPUT
40
+ echo "$DIFF" > /tmp/sdk-diff.patch
41
+ echo "$(echo "$DIFF" | wc -l) lines of SDK changes"
42
+ fi
43
+
44
+ - name: Check docs for staleness
45
+ if: steps.diff.outputs.has_changes == 'true'
46
+ uses: anthropics/claude-code-action@v1
47
+ with:
48
+ anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
49
+ prompt: |
50
+ SDK source code was just updated. Check if any documentation needs to change.
51
+
52
+ 1. Read the SDK diff at /tmp/sdk-diff.patch to understand what changed
53
+ 2. Focus on user-facing changes: new/renamed/removed methods, changed parameters, new features, changed behavior. Skip internal refactors, test changes, and type-only changes.
54
+ 3. If there are user-facing changes, search docs/content/docs/ for pages that reference the affected APIs, patterns, or features
55
+ 4. Update any docs that would be stale or incorrect after this SDK change — guides, FAQs, examples, quickstart, etc.
56
+ 5. Do NOT touch docs/content/reference/ (those are auto-generated separately)
57
+ 6. Do NOT touch docs/content/changelog/ (changelogs are written separately)
58
+ 7. If no docs changes are needed, make no file changes
59
+
60
+ - name: Create PR if changed
61
+ if: steps.diff.outputs.has_changes == 'true'
62
+ env:
63
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
64
+ run: |
65
+ if [ -z "$(git status --porcelain)" ]; then
66
+ echo "No documentation changes needed"
67
+ exit 0
68
+ fi
69
+
70
+ BRANCH="docs/sdk-sync-${GITHUB_SHA::7}"
71
+ git config user.name "github-actions[bot]"
72
+ git config user.email "github-actions[bot]@users.noreply.github.com"
73
+ git checkout -b "$BRANCH"
74
+ git add -A
75
+ git commit -m "docs: update guides for SDK changes"
76
+ git push -u origin "$BRANCH"
77
+
78
+ gh pr create \
79
+ --base next \
80
+ --head "$BRANCH" \
81
+ --title "docs: update guides for SDK changes" \
82
+ --body "$(cat <<'EOF'
83
+ ## Summary
84
+ Automated docs update triggered by SDK source changes on `next`.
85
+
86
+ Claude reviewed the SDK diff and updated guides, FAQs, or examples
87
+ that reference changed APIs or features.
88
+
89
+ ## Review checklist
90
+ - [ ] Changes accurately reflect the new SDK behavior
91
+ - [ ] No unrelated docs were modified
92
+ - [ ] Code examples are correct and complete
93
+
94
+ Generated by Claude Code via GitHub Actions.
95
+ EOF
96
+ )"