mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 15:09:22 +00:00
a237ebabba
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
106 lines
3.5 KiB
Plaintext
106 lines
3.5 KiB
Plaintext
---
|
|
title: "Zapier Trigger"
|
|
description: "Trigger CrewAI crews from Zapier workflows to automate cross-app workflows"
|
|
icon: "bolt"
|
|
mode: "wide"
|
|
---
|
|
|
|
This guide will walk you through the process of setting up Zapier triggers for CrewAI AMP, allowing you to automate workflows between CrewAI AMP and other applications.
|
|
|
|
## Prerequisites
|
|
|
|
- A CrewAI AMP account
|
|
- A Zapier account
|
|
- A Slack account (for this specific example)
|
|
|
|
## Step-by-Step Setup
|
|
|
|
<Steps>
|
|
<Step title="Set Up the Slack Trigger">
|
|
- In Zapier, create a new Zap.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-1.png" alt="Zapier 1" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="Choose Slack as your trigger app">
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-2.png" alt="Zapier 2" />
|
|
</Frame>
|
|
- Select `New Pushed Message` as the Trigger Event.
|
|
- Connect your Slack account if you haven't already.
|
|
</Step>
|
|
|
|
<Step title="Configure the CrewAI AMP Action">
|
|
- Add a new action step to your Zap.
|
|
- Choose CrewAI+ as your action app and Kickoff as the Action Event
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-3.png" alt="Zapier 5" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="Connect your CrewAI AMP account">
|
|
- Connect your CrewAI AMP account.
|
|
- Select the appropriate Crew for your workflow.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-4.png" alt="Zapier 6" />
|
|
</Frame>
|
|
- Configure the inputs for the Crew using the data from the Slack message.
|
|
</Step>
|
|
|
|
<Step title="Format the CrewAI AMP Output">
|
|
- Add another action step to format the text output from CrewAI AMP.
|
|
- Use Zapier's formatting tools to convert the Markdown output to HTML.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-5.png" alt="Zapier 8" />
|
|
</Frame>
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-6.png" alt="Zapier 9" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="Send the Output via Email">
|
|
- Add a final action step to send the formatted output via email.
|
|
- Choose your preferred email service (e.g., Gmail, Outlook).
|
|
- Configure the email details, including recipient, subject, and body.
|
|
- Insert the formatted CrewAI AMP output into the email body.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-7.png" alt="Zapier 7" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="Kick Off the crew from Slack">
|
|
- Enter the text in your Slack channel
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-7b.png" alt="Zapier 10" />
|
|
</Frame>
|
|
|
|
- Select the 3 ellipsis button and then chose Push to Zapier
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-8.png" alt="Zapier 11" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="Select the crew and then Push to Kick Off">
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-9.png" alt="Zapier 12" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
## Tips for Success
|
|
|
|
- Ensure that your CrewAI AMP inputs are correctly mapped from the Slack message.
|
|
- Test your Zap thoroughly before turning it on to catch any potential issues.
|
|
- Consider adding error handling steps to manage potential failures in the workflow.
|
|
|
|
By following these steps, you'll have successfully set up Zapier triggers for CrewAI AMP, allowing for automated workflows triggered by Slack messages and resulting in email notifications with CrewAI AMP output.
|