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, 07:00 UTC
ci: add changelog-to-docs GitHub Action
When a changelog entry is pushed to next, Claude Code Action reads the entry and creates a PR with suggested documentation updates for affected pages. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sushmithamallesh committed
Feb 19, 2026 at 20:49 UTC
f6e3f9c4f8d0d1861f43f4ec15b2ef117433b5c6
2 files changed
+112
.github/workflows/docs.changelog-to-docs.yml
new
+59
@@ -0,0 +1,59 @@
1
+name: Changelog → Docs PR
2
+
3
+on:
4
+ push:
5
+ branches: [next]
6
+ paths:
7
+ - 'docs/content/changelog/**.mdx'
8
+
9
+jobs:
10
+ suggest-docs-updates:
11
+ name: Suggest Documentation Updates
12
+ runs-on: ubuntu-latest
13
+ permissions:
14
+ contents: write
15
+ pull-requests: write
16
+ issues: write
17
+ id-token: write
18
+
19
+ steps:
20
+ - name: Checkout repository
21
+ uses: actions/checkout@v6
22
+ with:
23
+ fetch-depth: 0
24
+
25
+ - name: Detect new changelog files
26
+ id: detect
27
+ run: |
28
+ BEFORE="${{ github.event.before }}"
29
+ AFTER="${{ github.event.after }}"
30
+
31
+ if [[ "$BEFORE" =~ ^0+$ ]]; then
32
+ FILES=$(git diff --name-only --diff-filter=AM HEAD^..HEAD | grep '^docs/content/changelog/.*\.mdx$' || echo "")
33
+ else
34
+ FILES=$(git diff --name-only --diff-filter=AM "$BEFORE".."$AFTER" | grep '^docs/content/changelog/.*\.mdx$' || echo "")
35
+ fi
36
+
37
+ if [ -z "$FILES" ]; then
38
+ echo "found=false" >> $GITHUB_OUTPUT
39
+ else
40
+ echo "found=true" >> $GITHUB_OUTPUT
41
+ echo "files<<EOF" >> $GITHUB_OUTPUT
42
+ echo "$FILES" >> $GITHUB_OUTPUT
43
+ echo "EOF" >> $GITHUB_OUTPUT
44
+ fi
45
+
46
+ - name: Claude suggests docs updates
47
+ if: steps.detect.outputs.found == 'true'
48
+ uses: anthropics/claude-code-action@v1
49
+ with:
50
+ anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
51
+ direct_prompt: |
52
+ New changelog entries were merged to next. Read the agent instructions and update documentation accordingly.
53
+
54
+ 1. Read docs/.claude/agents/changelog-docs-updater.md for full instructions
55
+ 2. Read each of these changelog files:
56
+ ${{ steps.detect.outputs.files }}
57
+ 3. For each change, search docs/content/docs/ for pages that need updating
58
+ 4. Make the documentation updates following the agent instructions
59
+ 5. If no docs changes are needed, make no file changes and explain why
docs/.claude/agents/changelog-docs-updater.md
new
+53
@@ -0,0 +1,53 @@
1
+# Changelog → Docs Updater
2
+
3
+Analyzes new changelog entries and updates documentation to reflect the changes.
4
+
5
+## When This Runs
6
+
7
+Triggered when a changelog file (`docs/content/changelog/*.mdx`) is pushed to `next`. Creates a PR with suggested documentation updates.
8
+
9
+## Process
10
+
11
+1. Read each new/modified changelog file
12
+2. Categorize the changes (breaking change, new feature, deprecation, bug fix, behavior change)
13
+3. For each change, search `docs/content/docs/` for pages that reference the affected feature
14
+4. Make targeted documentation updates
15
+
16
+## What to Update
17
+
18
+| Changelog Type | Docs Action |
19
+|---|---|
20
+| **Breaking change** (new API signature, removed parameter) | Update code examples in affected guides to use the new API |
21
+| **New feature** (new parameter, new method, new option) | Add to the relevant existing guide where it fits naturally |
22
+| **Deprecation** | Add a `<Callout type="warn">` note near the deprecated usage |
23
+| **Behavior change** (default changed, response format changed) | Update descriptions and examples that reference the old behavior |
24
+| **New toolkit support** | No docs changes needed (toolkits are auto-generated) |
25
+| **Bug fix** (no API change) | No docs changes needed |
26
+| **Performance improvement** | No docs changes needed |
27
+
28
+## Rules
29
+
30
+- Only modify files in `docs/content/docs/` and `docs/content/cookbooks/`
31
+- Do NOT create new pages — only update existing ones
32
+- Do NOT add changelog-style content ("as of v0.6.0...") to docs. Docs should describe current behavior.
33
+- Do NOT make cosmetic or stylistic changes unrelated to the changelog
34
+- Follow existing patterns in the docs (Tabs for Python/TypeScript, `<Callout>` for warnings)
35
+- TypeScript code blocks in MDX are type-checked at build time. Add proper imports above `// ---cut---` lines. See `docs/.claude/context/twoslash.md` for details.
36
+- If no documentation changes are needed, make no file changes
37
+
38
+## Key Docs Pages
39
+
40
+These are the most commonly affected pages. Search broadly, but start here:
41
+
42
+| Topic | Docs Page |
43
+|---|---|
44
+| Sessions API | `configuring-sessions.mdx` |
45
+| Authentication | `authentication.mdx`, `authenticating-users/` |
46
+| Tools & toolkits | `tools-and-toolkits.mdx`, `tools-direct/` |
47
+| Triggers & webhooks | `triggers.mdx`, `webhook-verification.mdx`, `setting-up-triggers/` |
48
+| Connected accounts | `managing-multiple-connected-accounts.mdx`, `auth-configuration/connected-accounts.mdx` |
49
+| Auth configs | `using-custom-auth-configuration.mdx`, `auth-configuration/` |
50
+| White labeling | `white-labeling-authentication.mdx` |
51
+| Migration | `migration-guide/` |
52
+| SDK quickstart | `quickstart.mdx` |
53
+| Providers | `providers/` |