@devries-cameron20 / composio-1 / commits / a7e695076
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

ci: fix review comments and add pipeline reference docs

- Fix checkout to use ref: next (Cursor bot high severity) - Use prompt instead of deprecated direct_prompt (Cursor bot low severity) - Add docs/.claude/context/pipelines.md with reference for all workflows - Add pipelines.md to CLAUDE.md context index Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Sushmitha Mallesh committed Mar 6, 2026 at 17:36 UTC a7e695076d7aa4d9a23a413e73bbcc14d35f6d90
3 files changed +52 -1
.github/workflows/docs.sync-connect-clients.yml
+2 -1
@@ -18,13 +18,14 @@ jobs:
18 - name: Checkout repository
19 uses: actions/checkout@v6
20 with:
21 + ref: next
22 fetch-depth: 1
23
24 - name: Sync Connect clients
25 uses: anthropics/claude-code-action@v1
26 with:
27 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
27 - direct_prompt: |
28 + prompt: |
29 Sync the Composio Connect clients page from the dashboard repo.
30
31 1. Read docs/.claude/agents/connect-clients-sync.md for full instructions
docs/.claude/context/pipelines.md new
+49
@@ -0,0 +1,49 @@
1 +# CI/CD Pipelines
2 +
3 +Reference for all GitHub Actions workflows related to docs.
4 +
5 +## Docs Workflows
6 +
7 +| Workflow | File | Trigger | What it does |
8 +|---|---|---|---|
9 +| **Update Data** | `docs-update-data.yml` | Cron (every 5h), `repository_dispatch` (Apollo deploy), manual | Fetches toolkits data, OpenAPI spec, and API index pages. Creates PR via `peter-evans/create-pull-request` targeting `next`. |
10 +| **Sync Connect Clients** | `docs.sync-connect-clients.yml` | Cron (daily 8 AM UTC), manual | Claude Code action syncs client definitions from `ComposioHQ/composio_dashboard` to `composio-connect.mdx`. Creates PR targeting `next`. Agent instructions: `docs/.claude/agents/connect-clients-sync.md`. |
11 +| **Changelog → Docs** | `docs.changelog-to-docs.yml` | Push to `next` (changelog files) | Codex action reads new changelog entries and updates docs pages. Creates PR targeting `next`. Agent instructions: `docs/.claude/agents/changelog-docs-updater.md`. |
12 +| **Check Links** | `docs-check-links.yml` | PR changes to `docs/` | Runs `bun run scripts/validate-links.ts` to catch broken internal links. |
13 +| **TypeScript Check** | `docs-typescript-check.yml` | PR changes to `docs/` | Runs `bun run types:check` for TypeScript type checking. |
14 +| **Docs Tests** | `docs-tests.yml` | PR changes to `docs/` | Runs the docs test suite. |
15 +| **Health Check** | `docs.health-check.yml` | Cron | Checks the live docs site is responding. |
16 +| **Changelog Notification** | `docs.changelog-notification.yml` | Push to `next` (changelog files) | Sends notification when new changelog entries are merged. |
17 +| **Doc Review** | `claude-code-doc-review.yml` | PR review comments with `@claude` | Claude Code reviews docs PRs on demand. Agent instructions: `docs/.claude/agents/docs-reviewer.md`. |
18 +
19 +## SDK/Build Workflows
20 +
21 +| Workflow | File | Trigger | What it does |
22 +|---|---|---|---|
23 +| **Generate SDK Docs** | `generate-sdk-docs.yml` | Manual, schedule | Generates SDK reference documentation. |
24 +| **TS Build** | `ts.build.yml` | PR changes to `ts/` | Builds TypeScript packages. |
25 +| **TS Test** | `ts.test.yml` | PR changes to `ts/` | Runs TypeScript tests. |
26 +| **TS E2E** | `ts.test-e2e.yml` | PR changes to `ts/` | Runs E2E tests (Node, Deno, Cloudflare). |
27 +| **TS Typecheck** | `ts.typecheck.yml` | PR changes to `ts/` | TypeScript type checking for SDK. |
28 +| **TS Release** | `ts.release.yml` | Push to `master` | Publishes TypeScript packages. |
29 +| **TS Audit** | `ts.audit.yml` | Cron | Security audit of npm dependencies. |
30 +| **Build CLI Binaries** | `build-cli-binaries.yml` | Release | Builds CLI binaries for distribution. |
31 +| **CLI Test Installation** | `cli.test-installation.yml` | PR changes to CLI | Tests CLI installation flow. |
32 +| **Python Check** | `py.check.yaml` | PR changes to `python/` | Linting and type checking for Python SDK. |
33 +| **Python Test** | `py.test.yml` | PR changes to `python/` | Runs Python tests. |
34 +| **Python Release** | `py.release.yml` | Push to `master` | Publishes Python packages. |
35 +
36 +## Other Workflows
37 +
38 +| Workflow | File | Trigger | What it does |
39 +|---|---|---|---|
40 +| **Claude Code** | `claude.yml` | Issue/PR comments with `@claude` | General-purpose Claude Code for repo-wide tasks. |
41 +| **Secrets Detection** | `security.secrets-detection.yml` | PR | Scans for accidentally committed secrets. |
42 +| **Stale** | `stale.yml` | Cron | Marks stale issues and PRs. |
43 +
44 +## Key Patterns
45 +
46 +- **Docs PRs always target `next`**, not `master`
47 +- **Auto-PR workflows** use `peter-evans/create-pull-request` or manual `gh pr create`
48 +- **AI agent workflows** use agent instruction files in `docs/.claude/agents/`
49 +- **Scheduled workflows** that checkout code for `next`-targeted PRs must use `ref: next`
docs/CLAUDE.md
+1
@@ -38,6 +38,7 @@ Detailed documentation for Claude is organized in `.claude/`:
38 - [twoslash.md](.claude/context/twoslash.md) - TypeScript code block type checking
39 - [sdk-reference.md](.claude/context/sdk-reference.md) - SDK doc generation
40 - [api-reference.md](.claude/context/api-reference.md) - API reference customizations (schema rendering, CSS overrides, upgrade notes)
41 +- [pipelines.md](.claude/context/pipelines.md) - CI/CD workflows reference (cron jobs, auto-PR, AI agents)
42
43 ### Guides (How-To)
44 - [changelog.md](.claude/guides/changelog.md) - Writing changelog entries