mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-07 07:59:29 +00:00
* 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>
344 lines
13 KiB
Plaintext
344 lines
13 KiB
Plaintext
---
|
|
title: "التحضير للنشر"
|
|
description: "تأكد من جاهزية طاقمك أو تدفقك للنشر على CrewAI AMP"
|
|
icon: "clipboard-check"
|
|
mode: "wide"
|
|
---
|
|
|
|
<Note>
|
|
قبل النشر على CrewAI AMP، من الضروري التحقق من صحة بنية مشروعك.
|
|
يمكن نشر كل من الطواقم والتدفقات كـ "أتمتات"، لكن لهما بنى مشاريع
|
|
ومتطلبات مختلفة يجب استيفاؤها لنجاح النشر.
|
|
</Note>
|
|
|
|
## فهم الأتمتات
|
|
|
|
في CrewAI AMP، **الأتمتات** هو المصطلح الشامل لمشاريع الذكاء الاصطناعي الوكيل القابلة للنشر. يمكن أن تكون الأتمتة إما:
|
|
|
|
- **طاقم**: فريق مستقل من وكلاء الذكاء الاصطناعي يعملون معاً على المهام
|
|
- **تدفق**: سير عمل مُنسّق يمكنه الجمع بين طواقم متعددة واستدعاءات LLM المباشرة والمنطق الإجرائي
|
|
|
|
فهم النوع الذي تنشره ضروري لأن لهما بنى مشاريع ونقاط دخول مختلفة.
|
|
|
|
## الطواقم مقابل التدفقات: الفروقات الرئيسية
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="مشاريع الطاقم" icon="users">
|
|
فرق وكلاء ذكاء اصطناعي مستقلة. الـ crews الجديدة تستخدم بنية JSON-first مع `crew.jsonc` و `agents/`؛ ويمكن للـ crews الكلاسيكية الاستمرار في استخدام `crew.py`.
|
|
</Card>
|
|
<Card title="مشاريع التدفق" icon="diagram-project">
|
|
سير عمل مُنسّق مع طواقم مضمنة في مجلد `crews/`. الأفضل للعمليات المعقدة متعددة المراحل.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
| الجانب | الطاقم | التدفق |
|
|
|--------|--------|--------|
|
|
| **بنية المشروع** | جذر المشروع مع `crew.jsonc` و `agents/` | `src/project_name/` مع مجلد `crews/` |
|
|
| **موقع المنطق الرئيسي** | `crew.jsonc` (كلاسيكي: `src/project_name/crew.py`) | `src/project_name/main.py` (فئة Flow) |
|
|
| **دالة نقطة الدخول** | تُحمّل من `crew.jsonc` (كلاسيكي: `run()` في `main.py`) | `kickoff()` في `main.py` |
|
|
| **نوع pyproject.toml** | `type = "crew"` | `type = "flow"` |
|
|
| **أمر CLI للإنشاء** | `crewai create crew name` | `crewai create flow name` |
|
|
| **موقع التهيئة** | `crew.jsonc` و `agents/` و `tools/` اختياريًا | `src/project_name/crews/crew_name/config/` أو مجلدات crew JSON مضمنة |
|
|
| **يمكن أن يحتوي طواقم أخرى** | لا | نعم (في مجلد `crews/`) |
|
|
|
|
## مرجع بنية المشروع
|
|
|
|
### بنية مشروع الطاقم
|
|
|
|
عند تشغيل `crewai create crew my_crew`، تحصل على بنية JSON-first:
|
|
|
|
```
|
|
my_crew/
|
|
├── .gitignore
|
|
├── pyproject.toml # Must have type = "crew"
|
|
├── README.md
|
|
├── .env
|
|
├── uv.lock # REQUIRED for deployment
|
|
├── crew.jsonc # إعدادات الـ crew والمهام والعملية والمدخلات
|
|
├── agents/
|
|
│ └── researcher.jsonc # تعريفات الـ Agents
|
|
├── tools/ # أدوات custom:<name> اختيارية
|
|
├── knowledge/
|
|
└── skills/
|
|
```
|
|
|
|
<Warning>
|
|
في crews بنمط JSON-first، أبقِ `crew.jsonc` و `agents/` و `tools/` و `knowledge/` و `skills/`
|
|
في جذر المشروع. وضعها داخل `src/` يمنع `crewai run` والتحقق قبل النشر من العثور على تعريف الـ crew.
|
|
</Warning>
|
|
|
|
<Info>
|
|
المشاريع الكلاسيكية التي تُنشأ عبر `crewai create crew my_crew --classic` تستخدم البنية القديمة
|
|
`src/project_name/crew.py` و `src/project_name/config/agents.yaml` و
|
|
`src/project_name/config/tasks.yaml`. تظل هذه البنية مدعومة للـ crews المكتوبة في Python مع decorators.
|
|
</Info>
|
|
|
|
### بنية مشروع التدفق
|
|
|
|
عند تشغيل `crewai create flow my_flow`، تحصل على هذه البنية:
|
|
|
|
```
|
|
my_flow/
|
|
├── .gitignore
|
|
├── pyproject.toml # Must have type = "flow"
|
|
├── README.md
|
|
├── .env
|
|
├── uv.lock # REQUIRED for deployment
|
|
└── src/
|
|
└── my_flow/
|
|
├── __init__.py
|
|
├── main.py # Entry point with kickoff() function + Flow class
|
|
├── crews/ # Embedded crews folder
|
|
│ └── poem_crew/
|
|
│ ├── __init__.py
|
|
│ ├── poem_crew.py # Crew with @CrewBase decorator
|
|
│ └── config/
|
|
│ ├── agents.yaml
|
|
│ └── tasks.yaml
|
|
└── tools/
|
|
├── __init__.py
|
|
└── custom_tool.py
|
|
```
|
|
|
|
<Info>
|
|
الـ crews المستقلة بنمط JSON-first تستخدم ملفات JSON في جذر المشروع. أما Flows فتظل تستخدم
|
|
`src/project_name/` ويمكن أن تحتوي crews مضمنة كلاسيكية أو مجلدات crew JSON يتم تحميلها عبر
|
|
`crewai.project.load_crew`.
|
|
</Info>
|
|
|
|
## قائمة فحص ما قبل النشر
|
|
|
|
استخدم هذه القائمة للتحقق من جاهزية مشروعك للنشر.
|
|
|
|
### 1. التحقق من تهيئة pyproject.toml
|
|
|
|
يجب أن يتضمن `pyproject.toml` قسم `[tool.crewai]` الصحيح:
|
|
|
|
<Tabs>
|
|
<Tab title="للطواقم">
|
|
```toml
|
|
[tool.crewai]
|
|
type = "crew"
|
|
```
|
|
</Tab>
|
|
<Tab title="للتدفقات">
|
|
```toml
|
|
[tool.crewai]
|
|
type = "flow"
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
<Warning>
|
|
إذا لم يتطابق `type` مع بنية مشروعك، سيفشل البناء أو
|
|
لن تعمل الأتمتة بشكل صحيح.
|
|
</Warning>
|
|
|
|
### 2. التأكد من وجود ملف uv.lock
|
|
|
|
يستخدم CrewAI `uv` لإدارة الاعتماديات. يضمن ملف `uv.lock` بناءً قابلاً للتكرار وهو **مطلوب** للنشر.
|
|
|
|
```bash
|
|
# إنشاء أو تحديث ملف القفل
|
|
uv lock
|
|
|
|
# التحقق من وجوده
|
|
ls -la uv.lock
|
|
```
|
|
|
|
إذا لم يكن الملف موجوداً، شغّل `uv lock` وارفعه إلى مستودعك:
|
|
|
|
```bash
|
|
uv lock
|
|
git add uv.lock
|
|
git commit -m "Add uv.lock for deployment"
|
|
git push
|
|
```
|
|
|
|
### 3. التحقق من تعريف الـ Crew
|
|
|
|
<Tabs>
|
|
<Tab title="JSON-first Crews">
|
|
يجب أن تحتوي crews بنمط JSON-first على `crew.jsonc` أو `crew.json` في جذر المشروع.
|
|
يجب أن يشير مصفوفة `agents` إلى ملفات داخل `agents/`، ويجب أن تشير كل task إلى اسم Agent صحيح.
|
|
|
|
```jsonc crew.jsonc
|
|
{
|
|
"name": "Research Crew",
|
|
"agents": ["researcher"],
|
|
"tasks": [
|
|
{
|
|
"name": "research_task",
|
|
"description": "Research {topic}.",
|
|
"expected_output": "A concise report.",
|
|
"agent": "researcher"
|
|
}
|
|
],
|
|
"inputs": {
|
|
"topic": "AI Agents"
|
|
}
|
|
}
|
|
```
|
|
|
|
تُشار الأدوات المخصصة بصيغة `"custom:<name>"` ويجب تنفيذها في
|
|
`tools/<name>.py` كصنف يرث من `BaseTool`.
|
|
</Tab>
|
|
<Tab title="Crews كلاسيكية Python/YAML">
|
|
يجب أن تستخدم الـ crews الكلاسيكية وPython crews المضمنة داخل Flows مزخرف `@CrewBase`.
|
|
|
|
```python
|
|
from crewai import Agent, Crew, Process, Task
|
|
from crewai.project import CrewBase, agent, crew, task
|
|
from crewai.agents.agent_builder.base_agent import BaseAgent
|
|
from typing import List
|
|
|
|
@CrewBase
|
|
class MyCrew():
|
|
"""My crew description"""
|
|
|
|
agents: List[BaseAgent]
|
|
tasks: List[Task]
|
|
|
|
@agent
|
|
def my_agent(self) -> Agent:
|
|
return Agent(
|
|
config=self.agents_config['my_agent'], # type: ignore[index]
|
|
verbose=True
|
|
)
|
|
|
|
@task
|
|
def my_task(self) -> Task:
|
|
return Task(
|
|
config=self.tasks_config['my_task'] # type: ignore[index]
|
|
)
|
|
|
|
@crew
|
|
def crew(self) -> Crew:
|
|
return Crew(
|
|
agents=self.agents,
|
|
tasks=self.tasks,
|
|
process=Process.sequential,
|
|
verbose=True,
|
|
)
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
### 4. التحقق من نقاط دخول المشروع
|
|
|
|
لا تحتاج crews المستقلة بنمط JSON-first إلى ملف `src/project_name/main.py` مكتوب يدويًا؛
|
|
يقوم `crewai run` وتغليف النشر بتحميل `crew.jsonc` مباشرة. تستخدم crews الكلاسيكية وFlows نقاط دخول Python:
|
|
|
|
<Tabs>
|
|
<Tab title="JSON-first Crews">
|
|
شغّل محليًا من جذر المشروع:
|
|
|
|
```bash
|
|
crewai run
|
|
```
|
|
</Tab>
|
|
<Tab title="Crews كلاسيكية">
|
|
تستخدم نقطة الدخول دالة `run()`:
|
|
|
|
```python
|
|
# src/my_crew/main.py
|
|
from my_crew.crew import MyCrew
|
|
|
|
def run():
|
|
"""Run the crew."""
|
|
inputs = {'topic': 'AI in Healthcare'}
|
|
result = MyCrew().crew().kickoff(inputs=inputs)
|
|
return result
|
|
|
|
if __name__ == "__main__":
|
|
run()
|
|
```
|
|
</Tab>
|
|
<Tab title="للتدفقات">
|
|
تستخدم نقطة الدخول دالة `kickoff()` مع فئة Flow:
|
|
|
|
```python
|
|
# src/my_flow/main.py
|
|
from crewai.flow import Flow, listen, start
|
|
from my_flow.crews.poem_crew.poem_crew import PoemCrew
|
|
|
|
class MyFlow(Flow):
|
|
@start()
|
|
def begin(self):
|
|
# Flow logic here
|
|
result = PoemCrew().crew().kickoff(inputs={...})
|
|
return result
|
|
|
|
def kickoff():
|
|
"""Run the flow."""
|
|
MyFlow().kickoff()
|
|
|
|
if __name__ == "__main__":
|
|
kickoff()
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
### 5. تحضير متغيرات البيئة
|
|
|
|
قبل النشر، تأكد من أن لديك:
|
|
|
|
1. **مفاتيح API لـ LLM** جاهزة (OpenAI، Anthropic، Google، إلخ.)
|
|
2. **مفاتيح API للأدوات** إذا كنت تستخدم أدوات خارجية (Serper، إلخ.)
|
|
|
|
<Info>
|
|
إذا كان مشروعك يعتمد على حزم من **سجل PyPI خاص**، ستحتاج أيضاً لتهيئة
|
|
بيانات اعتماد مصادقة السجل كمتغيرات بيئة. راجع
|
|
دليل [سجلات الحزم الخاصة](/ar/enterprise/guides/private-package-registry) للتفاصيل.
|
|
</Info>
|
|
|
|
<Tip>
|
|
اختبر مشروعك محلياً بنفس متغيرات البيئة قبل النشر
|
|
لاكتشاف مشاكل التهيئة مبكراً.
|
|
</Tip>
|
|
|
|
## أوامر التحقق السريع
|
|
|
|
شغّل هذه الأوامر من جذر مشروعك للتحقق السريع من إعدادك:
|
|
|
|
```bash
|
|
# 1. Check project type in pyproject.toml
|
|
grep -A2 "\[tool.crewai\]" pyproject.toml
|
|
|
|
# 2. Verify uv.lock exists
|
|
ls -la uv.lock || echo "ERROR: uv.lock missing! Run 'uv lock'"
|
|
|
|
# 3. For JSON-first crews, verify crew.jsonc and agents/
|
|
([ -f crew.jsonc ] || [ -f crew.json ]) || echo "No crew.jsonc or crew.json found"
|
|
test -d agents || echo "No agents/ directory found"
|
|
|
|
# 4. For classic Crews - verify crew.py exists
|
|
ls -la src/*/crew.py 2>/dev/null || echo "No crew.py (expected for Crews)"
|
|
|
|
# 5. For Flows - verify crews/ folder exists
|
|
ls -la src/*/crews/ 2>/dev/null || echo "No crews/ folder (expected for Flows)"
|
|
|
|
# 6. For classic Python crews - check for CrewBase usage
|
|
grep -r "@CrewBase" . --include="*.py"
|
|
```
|
|
|
|
## أخطاء الإعداد الشائعة
|
|
|
|
| الخطأ | العرض | الإصلاح |
|
|
|-------|-------|---------|
|
|
| `uv.lock` مفقود | فشل البناء أثناء حل الاعتماديات | شغّل `uv lock` وارفعه |
|
|
| `type` خاطئ في pyproject.toml | نجاح البناء لكن فشل وقت التشغيل | غيّر إلى النوع الصحيح |
|
|
| `crew.jsonc` أو `agents/` مفقود في crew بنمط JSON-first | لا يمكن العثور على تعريف الـ crew | أبقِ `crew.jsonc` و `agents/` في جذر المشروع |
|
|
| مُزخرف `@CrewBase` مفقود في crew كلاسيكية | أخطاء "Config not found" | أضف المُزخرف لجميع فئات الـ crew الكلاسيكية |
|
|
| ملفات كلاسيكية في الجذر بدل `src/` | نقطة الدخول غير موجودة | انقل ملفات Python الكلاسيكية إلى `src/project_name/` |
|
|
| `run()` أو `kickoff()` مفقودة | لا يمكن بدء الأتمتة | أضف دالة الدخول الصحيحة |
|
|
|
|
## الخطوات التالية
|
|
|
|
بمجرد اجتياز مشروعك لجميع عناصر القائمة، أنت جاهز للنشر:
|
|
|
|
<Card title="النشر على AMP" icon="rocket" href="/ar/enterprise/guides/deploy-to-amp">
|
|
اتبع دليل النشر لنشر طاقمك أو تدفقك على CrewAI AMP باستخدام
|
|
CLI أو واجهة الويب أو تكامل CI/CD.
|
|
</Card>
|