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.

feat: added github actions for fern (#1620)

Siddharth Balyand16bf708d576
diff --git a/.github/workflows/preview_docs.yml b/.github/workflows/preview_docs.yml
new file mode 100644
index 000000000..a1c7db6ae
--- /dev/null
+++ b/.github/workflows/preview_docs.yml
@@ -0,0 +1,68 @@
+name: Preview Docs
+
+on:
+ pull_request:
+ paths:
+ - 'fern/**'
+
+jobs:
+ run:
+ runs-on: ubuntu-latest
+ permissions: write-all
+ defaults:
+ run:
+ working-directory: ./fern
+ env:
+ COMPOSIO_API_KEY: ${{ inputs.api_key || secrets.COMPOSIO_API_KEY_PROD }}
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ - name: Install uv
+ uses: astral-sh/setup-uv@v5
+
+ - name: Install pnpm
+ uses: pnpm/action-setup@v4
+ with:
+ version: latest
+
+ - name: Install local dependencies
+ run: pnpm install
+
+ - name: Set up Python
+ run: uv python install
+
+ - name: Install Python Dependencies
+ run: |
+ uv sync
+ uv run composio apps generate-types
+
+ - name: Generate Tool Documentation
+ run: pnpm tools:generate
+
+ - name: Generate SDK Reference
+ run: pnpm sdkdocs
+
+ - name: Install Fern
+ run: npm install -g fern-api
+
+ - name: Pull Latest OpenAPI Specification
+ run: pnpm api:pull
+
+ - name: Generate preview URL
+ id: generate-docs
+ env:
+ FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+ POSTHOG_API_KEY: ${{ secrets.POSTHOG_API_KEY }}
+ run: |
+ OUTPUT=$(fern generate --docs --preview 2>&1) || true
+ echo "$OUTPUT"
+ URL=$(echo "$OUTPUT" | grep -oP 'Published docs to \K.*(?= \()')
+ echo "Preview URL: $URL"
+ echo "🌿 Preview your docs: $URL" > preview_url.txt
+
+ - name: Comment URL in PR
+ uses: thollander/[email protected]
+ with:
+ filePath: fern/preview_url.txt
diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml
new file mode 100644
index 000000000..1126d9a98
--- /dev/null
+++ b/.github/workflows/publish_docs.yml
@@ -0,0 +1,54 @@
+name: Publish Docs
+
+on:
+ push:
+ branches:
+ - next
+
+jobs:
+ run:
+ runs-on: ubuntu-latest
+ if: ${{ github.event_name == 'push' && contains(github.ref, 'refs/heads/next') && github.run_number > 1 }}
+ defaults:
+ run:
+ working-directory: ./fern
+ env:
+ COMPOSIO_API_KEY: ${{ inputs.api_key || secrets.COMPOSIO_API_KEY_PROD }}
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ - name: Install uv
+ uses: astral-sh/setup-uv@v5
+
+ - name: Install pnpm
+ uses: pnpm/action-setup@v4
+ with:
+ version: latest
+
+ - name: Install local dependencies
+ run: pnpm install
+
+ - name: Set up Python
+ run: uv python install
+
+ - name: Install Python Dependencies
+ run: |
+ uv sync
+ uv run composio apps generate-types
+
+ - name: Generate Tool Documentation
+ run: pnpm tools:generate
+
+ - name: Generate SDK Reference
+ run: pnpm sdkdocs
+
+ - name: Pull Latest OpenAPI Specification
+ run: pnpm api:pull
+
+ - name: Publish Docs
+ env:
+ POSTHOG_API_KEY: ${{ secrets.POSTHOG_API_KEY }}
+ FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ run: fern generate --docs