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>
104 lines
3.2 KiB
Plaintext
104 lines
3.2 KiB
Plaintext
---
|
||
title: "Automações"
|
||
description: "Gerencie, implante e monitore seus crews (automações) em um só lugar."
|
||
icon: "rocket"
|
||
mode: "wide"
|
||
---
|
||
|
||
## Visão geral
|
||
|
||
Automações é o hub operacional para seus crews implantados. Use para implantar via GitHub ou arquivo ZIP, gerenciar variáveis de ambiente, reimplantar quando necessário e monitorar o status de cada automação.
|
||
|
||
<Frame>
|
||
|
||
</Frame>
|
||
|
||
## Métodos de implantação
|
||
|
||
### Implantar via GitHub
|
||
|
||
Use para projetos versionados e implantação contínua.
|
||
|
||
<Steps>
|
||
<Step title="Conectar GitHub">
|
||
Clique em <b>Configure GitHub</b> e autorize o acesso.
|
||
</Step>
|
||
<Step title="Selecionar Repositório & Branch">
|
||
Escolha o <b>Repositório</b> e a <b>Branch</b> que deseja implantar.
|
||
</Step>
|
||
<Step title="Ativar Auto‑deploy (opcional)">
|
||
Ative <b>Automatically deploy new commits</b> para publicar a cada push.
|
||
</Step>
|
||
<Step title="Adicionar Variáveis de Ambiente">
|
||
Adicione segredos individualmente ou use <b>Bulk View</b> para múltiplas variáveis.
|
||
</Step>
|
||
<Step title="Implantar">
|
||
Clique em <b>Deploy</b> para criar sua automação.
|
||
</Step>
|
||
</Steps>
|
||
|
||
<Frame>
|
||
|
||
</Frame>
|
||
|
||
### Implantar via ZIP
|
||
|
||
Envie rapidamente sem Git — faça upload de um pacote ZIP do projeto.
|
||
|
||
<Steps>
|
||
<Step title="Escolher arquivo">
|
||
Selecione o arquivo ZIP do seu computador.
|
||
</Step>
|
||
<Step title="Adicionar Variáveis de Ambiente">
|
||
Informe as variáveis necessárias.
|
||
</Step>
|
||
<Step title="Implantar">
|
||
Clique em <b>Deploy</b> para criar sua automação.
|
||
</Step>
|
||
</Steps>
|
||
|
||
<Frame>
|
||
|
||
</Frame>
|
||
|
||
## Painel de Automações
|
||
|
||
A tabela lista todas as automações com detalhes chave:
|
||
|
||
- **CREW**: Nome da automação
|
||
- **STATUS**: Online / Failed / In Progress
|
||
- **URL**: Endpoint para kickoff/status
|
||
- **TOKEN**: Token da automação
|
||
- **ACTIONS**: Re‑deploy, delete e outros
|
||
|
||
Use os controles no canto superior direito para filtrar e pesquisar:
|
||
|
||
- Pesquisar por nome
|
||
- Filtrar por <b>Status</b>
|
||
- Filtrar por <b>Source</b> (GitHub / Studio / ZIP)
|
||
|
||
Após implantar, você pode ver os detalhes da automação e usar o menu **Options** para `chat with this crew`, `Export React Component` e `Export as MCP`.
|
||
|
||
<Frame>
|
||
|
||
</Frame>
|
||
|
||
## Boas práticas
|
||
|
||
- Prefira implantações via GitHub para controle de versão e CI/CD
|
||
- Use re‑deploy para avançar após mudanças de código/config ou habilite auto‑deploy a cada push
|
||
|
||
## Relacionados
|
||
|
||
<CardGroup cols={3}>
|
||
<Card title="Implantar um Crew" href="/pt-BR/enterprise/guides/deploy-to-amp" icon="rocket">
|
||
Implante um Crew via GitHub ou arquivo ZIP.
|
||
</Card>
|
||
<Card title="Gatilhos de Automação" href="/pt-BR/enterprise/guides/automation-triggers" icon="trigger">
|
||
Dispare automações por webhooks ou API.
|
||
</Card>
|
||
<Card title="Automação com Webhook" href="/pt-BR/enterprise/guides/webhook-automation" icon="webhook">
|
||
Transmita eventos e atualizações em tempo real.
|
||
</Card>
|
||
</CardGroup>
|