mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-04 06:29: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>
105 lines
3.0 KiB
Plaintext
105 lines
3.0 KiB
Plaintext
---
|
||
title: Automations
|
||
description: "Manage, deploy, and monitor your live crews (automations) in one place."
|
||
icon: "rocket"
|
||
mode: "wide"
|
||
---
|
||
|
||
## Overview
|
||
|
||
Automations is the live operations hub for your deployed crews. Use it to deploy from GitHub or a ZIP file, manage environment variables, re‑deploy when needed, and monitor the status of each automation.
|
||
|
||
<Frame>
|
||
|
||
|
||
</Frame>
|
||
|
||
## Deployment Methods
|
||
|
||
### Deploy from GitHub
|
||
|
||
Use this for version‑controlled projects and continuous deployment.
|
||
|
||
<Steps>
|
||
<Step title="Connect GitHub">
|
||
Click <b>Configure GitHub</b> and authorize access.
|
||
</Step>
|
||
<Step title="Select Repository & Branch">
|
||
Choose the <b>Repository</b> and <b>Branch</b> you want to deploy from.
|
||
</Step>
|
||
<Step title="Enable Auto‑deploy (optional)">
|
||
Turn on <b>Automatically deploy new commits</b> to ship updates on every push.
|
||
</Step>
|
||
<Step title="Add Environment Variables">
|
||
Add secrets individually or use <b>Bulk View</b> for multiple variables.
|
||
</Step>
|
||
<Step title="Deploy">
|
||
Click <b>Deploy</b> to create your live automation.
|
||
</Step>
|
||
</Steps>
|
||
|
||
<Frame>
|
||
|
||
</Frame>
|
||
|
||
### Deploy from ZIP
|
||
|
||
Ship quickly without Git—upload a compressed package of your project.
|
||
|
||
<Steps>
|
||
<Step title="Choose File">
|
||
Select the ZIP archive from your computer.
|
||
</Step>
|
||
<Step title="Add Environment Variables">
|
||
Provide any required variables or keys.
|
||
</Step>
|
||
<Step title="Deploy">
|
||
Click <b>Deploy</b> to create your live automation.
|
||
</Step>
|
||
</Steps>
|
||
|
||
<Frame>
|
||
|
||
</Frame>
|
||
|
||
## Automations Dashboard
|
||
|
||
The table lists all live automations with key details:
|
||
|
||
- **CREW**: Automation name
|
||
- **STATUS**: Online / Failed / In Progress
|
||
- **URL**: Endpoint for kickoff/status
|
||
- **TOKEN**: Automation token
|
||
- **ACTIONS**: Re‑deploy, delete, and more
|
||
|
||
Use the top‑right controls to filter and search:
|
||
|
||
- Search by name
|
||
- Filter by <b>Status</b>
|
||
- Filter by <b>Source</b> (GitHub / Studio / ZIP)
|
||
|
||
Once deployed, you can view the automation details and have the **Options** dropdown menu to `chat with this crew`, `Export React Component` and `Export as MCP`.
|
||
|
||
<Frame>
|
||
|
||
</Frame>
|
||
|
||
## Best Practices
|
||
|
||
- Prefer GitHub deployments for version control and CI/CD
|
||
- Use re‑deploy to roll forward after code or config updates or set it to auto-deploy on every push
|
||
|
||
## Related
|
||
|
||
<CardGroup cols={3}>
|
||
<Card title="Deploy a Crew" href="/en/enterprise/guides/deploy-crew" icon="rocket">
|
||
Deploy a Crew from GitHub or ZIP file.
|
||
</Card>
|
||
<Card title="Automation Triggers" href="/en/enterprise/guides/automation-triggers" icon="trigger">
|
||
Trigger automations via webhooks or API.
|
||
</Card>
|
||
<Card title="Webhook Automation" href="/en/enterprise/guides/webhook-automation" icon="webhook">
|
||
Stream real-time events and updates to your systems.
|
||
</Card>
|
||
</CardGroup>
|