mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +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.8 KiB
Plaintext
106 lines
3.8 KiB
Plaintext
---
|
|
title: "Zapier 트리거"
|
|
description: "Zapier 워크플로우에서 CrewAI crew를 트리거하여 앱 간 워크플로우를 자동화합니다"
|
|
icon: "bolt"
|
|
mode: "wide"
|
|
---
|
|
|
|
이 가이드는 CrewAI AOP용 Zapier 트리거를 설정하는 과정을 안내합니다. 이를 통해 CrewAI AOP와 기타 애플리케이션 간의 워크플로우를 자동화할 수 있습니다.
|
|
|
|
## 사전 요구 사항
|
|
|
|
- CrewAI AMP 계정
|
|
- Zapier 계정
|
|
- Slack 계정 (이 특정 예시에 해당)
|
|
|
|
## 단계별 설정
|
|
|
|
<Steps>
|
|
<Step title="Slack 트리거 설정">
|
|
- Zapier에서 새 Zap을 만듭니다.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-1.png" alt="Zapier 1" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="트리거 앱으로 Slack 선택">
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-2.png" alt="Zapier 2" />
|
|
</Frame>
|
|
- 트리거 이벤트로 `New Pushed Message`를 선택합니다.
|
|
- 아직 Slack 계정을 연결하지 않았다면 연결하세요.
|
|
</Step>
|
|
|
|
<Step title="CrewAI AMP 액션 구성">
|
|
- Zap에 새 액션 단계를 추가합니다.
|
|
- CrewAI+를 액션 앱으로, Kickoff를 액션 이벤트로 선택합니다.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-3.png" alt="Zapier 5" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="CrewAI AMP 계정 연결">
|
|
- CrewAI AMP 계정을 연결하세요.
|
|
- 워크플로에 적합한 Crew를 선택하세요.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-4.png" alt="Zapier 6" />
|
|
</Frame>
|
|
- Slack 메시지의 데이터를 사용하여 Crew의 입력값을 구성하세요.
|
|
</Step>
|
|
|
|
<Step title="CrewAI AMP 출력 포맷팅">
|
|
- CrewAI AOP에서 출력된 텍스트를 포맷팅하기 위해 추가 액션 단계를 추가합니다.
|
|
- Zapier의 포매팅 도구를 사용하여 Markdown 출력을 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="출력 이메일로 전송">
|
|
- 포맷팅된 출력을 이메일로 전송하는 마지막 액션 단계를 추가합니다.
|
|
- 원하는 이메일 서비스를 선택하세요 (예: Gmail, Outlook).
|
|
- 수신자, 제목, 본문 등 이메일 상세 정보를 구성하세요.
|
|
- 포맷팅된 CrewAI AMP 출력을 이메일 본문에 삽입합니다.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-7.png" alt="Zapier 7" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="Slack에서 crew 실행">
|
|
- Slack 채널에 텍스트를 입력하세요.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-7b.png" alt="Zapier 10" />
|
|
</Frame>
|
|
|
|
- 3점 버튼을 선택한 후 'Push to Zapier'를 선택하세요.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-8.png" alt="Zapier 11" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="crew 선택 후 Kick Off로 Push">
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-9.png" alt="Zapier 12" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
## 성공을 위한 팁
|
|
|
|
- CrewAI AMP 입력값이 Slack 메시지에서 올바르게 매핑되었는지 확인하세요.
|
|
- Zap을 활성화하기 전에 철저히 테스트하여 잠재적인 문제를 미리 파악하세요.
|
|
- 워크플로우 내에서 발생할 수 있는 실패 상황을 관리하기 위해 오류 처리 단계를 추가하는 것을 고려하세요.
|
|
|
|
이 단계를 따르면 Slack 메시지로 트리거되는 자동화된 워크플로우와 CrewAI AMP 출력이 포함된 이메일 알림을 설정할 수 있습니다.
|