mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28:10 +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>
97 lines
2.8 KiB
Plaintext
97 lines
2.8 KiB
Plaintext
---
|
|
title: "Gmail Trigger"
|
|
description: "Trigger automations when Gmail events occur (e.g., new emails, labels)."
|
|
icon: "envelope"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Overview
|
|
|
|
Use the Gmail Trigger to kick off your deployed crews when Gmail events happen in connected accounts, such as receiving a new email or messages matching a label/filter.
|
|
|
|
<Tip>
|
|
Make sure Gmail is connected in Tools & Integrations and the trigger is
|
|
enabled for your deployment.
|
|
</Tip>
|
|
|
|
## Enabling the Gmail Trigger
|
|
|
|
1. Open your deployment in CrewAI AMP
|
|
2. Go to the **Triggers** tab
|
|
3. Locate **Gmail** and switch the toggle to enable
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/trigger-selected.png"
|
|
alt="Enable or disable triggers with toggle"
|
|
/>
|
|
</Frame>
|
|
|
|
## Example: Process new emails
|
|
|
|
When a new email arrives, the Gmail Trigger will send the payload to your Crew or Flow. Below is a Crew example that parses and processes the trigger payload.
|
|
|
|
```python
|
|
@CrewBase
|
|
class GmailProcessingCrew:
|
|
@agent
|
|
def parser(self) -> Agent:
|
|
return Agent(
|
|
config=self.agents_config['parser'],
|
|
)
|
|
|
|
@task
|
|
def parse_gmail_payload(self) -> Task:
|
|
return Task(
|
|
config=self.tasks_config['parse_gmail_payload'],
|
|
agent=self.parser(),
|
|
)
|
|
|
|
@task
|
|
def act_on_email(self) -> Task:
|
|
return Task(
|
|
config=self.tasks_config['act_on_email'],
|
|
agent=self.parser(),
|
|
)
|
|
```
|
|
|
|
The Gmail payload will be available via the standard context mechanisms.
|
|
|
|
### 로컬에서 테스트
|
|
|
|
CrewAI CLI를 사용하여 Gmail 트리거 통합을 로컬에서 테스트하세요:
|
|
|
|
```bash
|
|
# 사용 가능한 모든 트리거 보기
|
|
crewai triggers list
|
|
|
|
# 실제 payload로 Gmail 트리거 시뮬레이션
|
|
crewai triggers run gmail/new_email_received
|
|
```
|
|
|
|
`crewai triggers run` 명령은 완전한 Gmail payload로 크루를 실행하여 배포 전에 파싱 로직을 테스트할 수 있게 해줍니다.
|
|
|
|
<Warning>
|
|
개발 중에는 `crewai triggers run gmail/new_email_received`을 사용하세요
|
|
(`crewai run`이 아님). 배포 후에는 크루가 자동으로 트리거 payload를 받습니다.
|
|
</Warning>
|
|
|
|
## Monitoring Executions
|
|
|
|
Track history and performance of triggered runs:
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/list-executions.png"
|
|
alt="List of executions triggered by automation"
|
|
/>
|
|
</Frame>
|
|
|
|
## Troubleshooting
|
|
|
|
- Ensure Gmail is connected in Tools & Integrations
|
|
- Verify the Gmail Trigger is enabled on the Triggers tab
|
|
- `crewai triggers run gmail/new_email_received`로 로컬 테스트하여 정확한 payload 구조를 확인하세요
|
|
- Check the execution logs and confirm the payload is passed as `crewai_trigger_payload`
|
|
- 주의: 트리거 실행을 시뮬레이션하려면 `crewai triggers run`을 사용하세요 (`crewai run`이 아님)
|