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.

docs: improve PR descriptions in docs automation workflows

Sushmitha Malleshe095aaf7f26f
diff --git a/.github/workflows/docs-update-data.yml b/.github/workflows/docs-update-data.yml
index 806815b5f..e9d2eca9a 100644
--- a/.github/workflows/docs-update-data.yml
+++ b/.github/workflows/docs-update-data.yml
@@ -71,19 +71,16 @@ jobs:
uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0
with:
commit-message: 'docs: update toolkits and API data'
- title: 'docs: Update toolkits and API data'
+ title: 'docs: update toolkits, API spec, and meta tools data'
body: |
- Auto-generated update from Apollo production deployment.
+ ## Summary
+ Automated sync of backend data into the docs site. Triggered by: `${{ github.event_name }}`${{ github.event_name == 'repository_dispatch' && format(' (Hermes commit: {0})', github.event.client_payload.hermes_commit) || '' }}.
- This PR updates:
- - `docs/public/data/toolkits.json` - Full toolkit data
- - `docs/public/data/toolkits-list.json` - Light toolkit list
- - `docs/public/openapi.json` - OpenAPI specification
- - `docs/content/reference/api-reference/*.mdx` - API index pages
- - `docs/public/data/meta-tools.json` - Meta tools schemas
- - `docs/content/reference/meta-tools/*.mdx` - Meta tools reference pages
-
- ${{ github.event_name == 'repository_dispatch' && format('Hermes commit: {0}', github.event.client_payload.hermes_commit) || '' }}
+ ## What changed
+ - **Toolkit catalog** (`docs/public/data/toolkits.json`, `toolkits-list.json`) — refreshed list of available toolkits, auth schemes, and tools from the backend API
+ - **OpenAPI spec** (`docs/public/openapi.json`) — latest API specification fetched from production
+ - **API reference pages** (`docs/content/reference/api-reference/*.mdx`) — regenerated index pages from the updated OpenAPI spec
+ - **Meta tools reference** (`docs/public/data/meta-tools.json`, `docs/content/reference/meta-tools/*.mdx`) — updated meta tool schemas and reference docs
branch: docs/auto-update-data
base: next
add-paths: |
diff --git a/.github/workflows/generate-sdk-docs.yml b/.github/workflows/generate-sdk-docs.yml
index 4ab3673e5..e547f187f 100644
--- a/.github/workflows/generate-sdk-docs.yml
+++ b/.github/workflows/generate-sdk-docs.yml
@@ -30,8 +30,12 @@ jobs:
uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0
with:
commit-message: 'docs: auto-generate TypeScript SDK reference'
- title: 'docs: Update TypeScript SDK reference'
- body: Auto-generated TypeScript SDK docs.
+ title: 'docs: update TypeScript SDK reference from source'
+ body: |
+ ## Summary
+ Auto-generated TypeScript SDK reference docs from `ts/packages/core/src/`.
+
+ Regenerates pages at `docs/content/reference/sdk-reference/typescript/` to reflect changes in the core package's public API (new methods, updated signatures, changed types).
branch: docs/auto-update-ts-sdk-reference
base: next
add-paths: docs/content/reference/sdk-reference/typescript/
@@ -55,8 +59,12 @@ jobs:
uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # v8.0.0
with:
commit-message: 'docs: auto-generate Python SDK reference'
- title: 'docs: Update Python SDK reference'
- body: Auto-generated Python SDK docs.
+ title: 'docs: update Python SDK reference from source'
+ body: |
+ ## Summary
+ Auto-generated Python SDK reference docs from `python/composio/`.
+
+ Regenerates pages at `docs/content/reference/sdk-reference/python/` to reflect changes in the Python package's public API (new methods, updated signatures, changed types).
branch: docs/auto-update-python-sdk-reference
base: next
add-paths: docs/content/reference/sdk-reference/python/