mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 21:58:11 +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.1 KiB
Plaintext
104 lines
3.1 KiB
Plaintext
---
|
|
title: "자동화"
|
|
description: "배포된 크루(자동화)를 한 곳에서 관리, 배포 및 모니터링하세요."
|
|
icon: "rocket"
|
|
mode: "wide"
|
|
---
|
|
|
|
## 개요
|
|
|
|
자동화는 배포된 크루를 운영하는 허브입니다. GitHub 또는 ZIP으로 배포하고, 환경 변수를 관리하고, 필요 시 재배포하며 각 자동화의 상태를 모니터링하세요.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
## 배포 방법
|
|
|
|
### GitHub로 배포
|
|
|
|
버전 관리 및 지속적 배포에 적합합니다.
|
|
|
|
<Steps>
|
|
<Step title="GitHub 연결">
|
|
<b>Configure GitHub</b>를 클릭하고 접근을 승인합니다.
|
|
</Step>
|
|
<Step title="리포지토리 & 브랜치 선택">
|
|
배포할 <b>리포지토리</b>와 <b>브랜치</b>를 선택합니다.
|
|
</Step>
|
|
<Step title="자동 배포 활성화(선택)">
|
|
<b>Automatically deploy new commits</b>를 켜면 푸시 시마다 자동 배포됩니다.
|
|
</Step>
|
|
<Step title="환경 변수 추가">
|
|
개별로 추가하거나 <b>Bulk View</b>를 사용해 여러 변수를 한 번에 추가합니다.
|
|
</Step>
|
|
<Step title="배포">
|
|
<b>Deploy</b>를 클릭해 라이브 자동화를 생성합니다.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
### ZIP으로 배포
|
|
|
|
Git 없이 빠르게 배포 — 프로젝트 ZIP 패키지를 업로드하세요.
|
|
|
|
<Steps>
|
|
<Step title="파일 선택">
|
|
컴퓨터에서 ZIP 파일을 선택합니다.
|
|
</Step>
|
|
<Step title="환경 변수 추가">
|
|
필요한 변수를 제공합니다.
|
|
</Step>
|
|
<Step title="배포">
|
|
<b>Deploy</b>를 클릭해 라이브 자동화를 생성합니다.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
## 자동화 대시보드
|
|
|
|
테이블에는 모든 라이브 자동화가 다음 정보와 함께 표시됩니다:
|
|
|
|
- **CREW**: 자동화 이름
|
|
- **STATUS**: Online / Failed / In Progress
|
|
- **URL**: kickoff/status 엔드포인트
|
|
- **TOKEN**: 자동화 토큰
|
|
- **ACTIONS**: 재배포, 삭제 등
|
|
|
|
우측 상단 컨트롤로 필터 및 검색:
|
|
|
|
- 이름으로 검색
|
|
- <b>Status</b>로 필터
|
|
- <b>Source</b>로 필터 (GitHub / Studio / ZIP)
|
|
|
|
배포 후 **Options** 드롭다운에서 `chat with this crew`, `Export React Component`, `Export as MCP`를 사용할 수 있습니다.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
## 모범 사례
|
|
|
|
- 버전 관리 및 CI/CD를 위해 GitHub 배포를 권장
|
|
- 코드/구성 변경 후 재배포 사용 또는 푸시마다 자동 배포 설정
|
|
|
|
## 관련 문서
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="크루 배포" href="/ko/enterprise/guides/deploy-to-amp" icon="rocket">
|
|
GitHub 또는 ZIP 파일로 크루 배포
|
|
</Card>
|
|
<Card title="자동화 트리거" href="/ko/enterprise/guides/automation-triggers" icon="trigger">
|
|
웹훅 또는 API로 자동화 트리거
|
|
</Card>
|
|
<Card title="Webhook 자동화" href="/ko/enterprise/guides/webhook-automation" icon="webhook">
|
|
실시간 이벤트/업데이트 스트리밍
|
|
</Card>
|
|
</CardGroup>
|