Skip to content

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: improve SDK docs workflow efficiency

Sushmithamallesh0dcacdc5a463
diff --git a/.github/workflows/generate-sdk-docs.yml b/.github/workflows/generate-sdk-docs.yml
index c308e00e3..0a3f2223d 100644
--- a/.github/workflows/generate-sdk-docs.yml
+++ b/.github/workflows/generate-sdk-docs.yml
@@ -6,7 +6,7 @@ on:
paths:
- 'ts/packages/core/src/**'
- 'python/composio/**'
- workflow_dispatch: # Allow manual trigger
+ workflow_dispatch:
jobs:
generate-ts-docs:
@@ -16,51 +16,28 @@ jobs:
pull-requests: write
steps:
- - name: Checkout
- uses: actions/checkout@v4
+ - uses: actions/checkout@v4
- - name: Setup pnpm
- uses: pnpm/action-setup@v4
+ - uses: pnpm/action-setup@v4
- - name: Setup Node.js
- uses: actions/setup-node@v4
+ - uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'pnpm'
- - name: Install dependencies
- run: pnpm install --frozen-lockfile
+ - run: pnpm install --frozen-lockfile
- - name: Generate TypeScript SDK docs
- run: pnpm --filter @composio/core generate:docs
-
- - name: Check for changes
- id: changes
- run: |
- # Check for both modified and untracked files
- if [[ -n $(git status --porcelain fumadocs/content/reference/sdk-reference/typescript/) ]]; then
- echo "has_changes=true" >> $GITHUB_OUTPUT
- fi
+ - run: pnpm --filter @composio/core generate:docs
- name: Create Pull Request
- if: steps.changes.outputs.has_changes == 'true'
uses: peter-evans/create-pull-request@v6
with:
- token: ${{ secrets.GITHUB_TOKEN }}
commit-message: 'docs: auto-generate TypeScript SDK reference'
title: 'docs: Update TypeScript SDK reference'
- body: |
- Auto-generated because TypeScript SDK source files changed.
-
- ---
- *Generated by [generate-sdk-docs.yml](../blob/next/.github/workflows/generate-sdk-docs.yml)*
+ body: Auto-generated TypeScript SDK docs.
branch: docs/auto-update-ts-sdk-reference
base: next
- add-paths: |
- fumadocs/content/reference/sdk-reference/typescript/
- labels: |
- documentation
- automated
+ add-paths: fumadocs/content/reference/sdk-reference/typescript/
generate-python-docs:
runs-on: ubuntu-latest
@@ -69,41 +46,20 @@ jobs:
pull-requests: write
steps:
- - name: Checkout
- uses: actions/checkout@v4
-
- - name: Setup uv
- uses: astral-sh/setup-uv@v4
+ - uses: actions/checkout@v4
- - name: Generate Python SDK docs
- run: |
- cd python
- uv run --with griffe python scripts/generate-docs.py
+ - uses: astral-sh/setup-uv@v4
+ with:
+ enable-cache: true
- - name: Check for changes
- id: changes
- run: |
- # Check for both modified and untracked files
- if [[ -n $(git status --porcelain fumadocs/content/reference/sdk-reference/python/) ]]; then
- echo "has_changes=true" >> $GITHUB_OUTPUT
- fi
+ - run: cd python && uv run --with griffe python scripts/generate-docs.py
- name: Create Pull Request
- if: steps.changes.outputs.has_changes == 'true'
uses: peter-evans/create-pull-request@v6
with:
- token: ${{ secrets.GITHUB_TOKEN }}
commit-message: 'docs: auto-generate Python SDK reference'
title: 'docs: Update Python SDK reference'
- body: |
- Auto-generated because Python SDK source files changed.
-
- ---
- *Generated by [generate-sdk-docs.yml](../blob/next/.github/workflows/generate-sdk-docs.yml)*
+ body: Auto-generated Python SDK docs.
branch: docs/auto-update-python-sdk-reference
base: next
- add-paths: |
- fumadocs/content/reference/sdk-reference/python/
- labels: |
- documentation
- automated
+ add-paths: fumadocs/content/reference/sdk-reference/python/