@devries-cameron20 / composio Mirror · read-only
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.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 06:00 UTC

next
md 49 lines 8.18 KB
Rendered Raw
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, both OpenAPI specs (v3.1 + v3.0), generates API index pages for both versions, and meta tools reference. Creates PR via `peter-evans/create-pull-request` targeting `next`. Tracks: `openapi.json`, `openapi-v3.json`, `api-reference/`, `v3/api-reference/`. |
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/agent-guidance/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/agent-guidance/agents/changelog-docs-updater.md`. |
12 | **Check Links** | `docs-check-links.yml` | PR changes to `docs/` or `ts/docs/` | Runs `bun run lint:links` to check docs-site links and SDK Markdown file targets and heading anchors. |
13 | **Lint + TypeScript** | `docs-typescript-check.yml` | PR changes to `docs/` | Runs `bun run lint` (oxlint), `bun run types:check`, and `bun run build` (validates Twoslash code blocks). |
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/agent-guidance/agents/docs-reviewer.md`. |
18
19 ## SDK/Build Workflows
20
21 | Workflow | File | Trigger | What it does |
22 | ------------------------- | ------------------------------ | ---------------------------------------------- | -------------------------------------------------------------------------- |
23 | **SDK Reference Drift** | `docs-sdk-reference-drift.yml` | PR to `next` changing SDK source or generators | Regenerates both SDK references and fails if the committed output differs. |
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, Cloudflare, CLI). |
27 | **TS Typecheck** | `ts.typecheck.yml` | PR changes to `ts/` | TypeScript type checking for SDK. |
28 | **TS Release** | `ts.release.yml` | Push to `next`, manual | Creates Changesets release PRs and 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` | `py@*` tags, manual | Builds and 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/agent-guidance/agents/`
49 - **Scheduled workflows** that checkout code for `next`-targeted PRs must use `ref: next`