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>
92 lines
3.7 KiB
Plaintext
92 lines
3.7 KiB
Plaintext
---
|
|
title: "크루 업데이트"
|
|
description: "CrewAI AOP에서 크루 업데이트하기"
|
|
icon: "pencil"
|
|
mode: "wide"
|
|
---
|
|
|
|
<Note>
|
|
CrewAI AOP에 crew를 배포한 후, 코드, 보안 설정 또는 구성을 업데이트해야 할 수
|
|
있습니다. 이 가이드는 이러한 일반적인 업데이트 작업을 수행하는 방법을
|
|
설명합니다.
|
|
</Note>
|
|
|
|
## 왜 Crew를 업데이트해야 하나요?
|
|
|
|
CrewAI는 기본적으로 GitHub 업데이트를 자동으로 반영하지 않으므로, 배포 시 `Auto-update` 옵션을 선택하지 않았다면 수동으로 업데이트를 트리거해야 합니다.
|
|
|
|
Crew 배포를 업데이트하고 싶은 이유는 여러 가지가 있을 수 있습니다:
|
|
|
|
- GitHub에 푸시한 최신 커밋으로 코드를 업데이트하고 싶은 경우
|
|
- 보안상의 이유로 bearer 토큰을 재설정하고 싶은 경우
|
|
- 환경 변수를 업데이트하고 싶은 경우
|
|
|
|
## 1. 최신 커밋으로 Crew 코드 업데이트하기
|
|
|
|
GitHub 저장소에 새로운 커밋을 푸시한 후 배포를 업데이트하려면 다음 단계를 따르세요:
|
|
|
|
1. CrewAI AMP 플랫폼에서 자신의 crew로 이동하세요.
|
|
2. crew 상세 페이지에서 `Re-deploy` 버튼을 클릭하세요.
|
|
|
|
<Frame></Frame>
|
|
|
|
이 작업을 수행하면 진행률 표시줄을 통해 추적할 수 있는 업데이트가 트리거됩니다. 시스템은 저장소에서 최신 코드를 가져와서 배포를 다시 빌드합니다.
|
|
|
|
## 2. 베어러 토큰 재설정
|
|
|
|
현재 토큰이 유출되었을 가능성이 있다고 의심되는 경우 등, 새 베어러 토큰을 생성해야 한다면 다음 단계를 따르세요:
|
|
|
|
1. CrewAI AMP 플랫폼에서 해당 crew로 이동하세요.
|
|
2. `Bearer Token` 섹션을 찾으세요.
|
|
3. 현재 토큰 옆에 있는 `Reset` 버튼을 클릭하세요.
|
|
|
|
<Frame></Frame>
|
|
|
|
<Warning>
|
|
베어러 토큰을 재설정하면 이전 토큰은 즉시 사용할 수 없게 됩니다. 이전 토큰을
|
|
사용하고 있는 모든 애플리케이션이나 스크립트에서 토큰을 반드시 업데이트하세요.
|
|
</Warning>
|
|
|
|
## 3. 환경 변수 업데이트하기
|
|
|
|
crew의 환경 변수를 업데이트하려면 다음 단계를 따르세요:
|
|
|
|
1. 먼저 crew 이름을 클릭하여 배포 페이지에 접속합니다.
|
|
|
|
<Frame></Frame>
|
|
|
|
2. `Environment Variables` 섹션을 찾습니다 (`Settings` 아이콘을 클릭해야 접근할 수 있습니다)
|
|
3. 제공된 필드에서 기존 변수를 수정하거나 새 변수를 추가합니다
|
|
4. 수정한 각 변수 옆의 `Update` 버튼을 클릭합니다
|
|
|
|
<Frame></Frame>
|
|
|
|
5. 마지막으로, 변경 사항을 적용하려면 페이지 하단의 `Update Deployment` 버튼을 클릭합니다
|
|
|
|
<Note>
|
|
환경 변수를 업데이트하면 새로운 배포가 트리거되지만, 이는 환경 설정만
|
|
업데이트하며 코드 자체는 변경되지 않습니다.
|
|
</Note>
|
|
|
|
## 업데이트 후
|
|
|
|
업데이트를 수행한 후:
|
|
|
|
1. 시스템이 crew를 다시 빌드하고 배포합니다
|
|
2. 실시간으로 배포 진행 상황을 모니터링할 수 있습니다
|
|
3. 완료되면 변경 사항이 예상대로 작동하는지 crew를 테스트합니다
|
|
|
|
<Tip>
|
|
업데이트 후 문제가 발생하면 플랫폼에서 배포 로그를 확인하거나 지원팀에
|
|
문의하여 도움을 받을 수 있습니다.
|
|
</Tip>
|
|
|
|
<Card
|
|
title="도움이 필요하신가요?"
|
|
icon="headset"
|
|
href="mailto:support@crewai.com"
|
|
>
|
|
crew 업데이트나 배포 문제 해결에 대해 지원이 필요하시면 지원팀에 문의해
|
|
주세요.
|
|
</Card>
|