mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-24 00:05:08 +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>
225 lines
8.0 KiB
Plaintext
225 lines
8.0 KiB
Plaintext
---
|
|
title: "النشر من Monorepo"
|
|
description: "انشر Crew أو Flow من مجلد فرعي داخل مستودع أكبر"
|
|
icon: "folder-tree"
|
|
mode: "wide"
|
|
---
|
|
|
|
<Note>
|
|
استخدم دليل عمل عندما يكون Crew أو Flow داخل مستودع أكبر. يتحقق CrewAI AMP
|
|
من الأتمتة ويبنيها ويشغلها من ذلك المجلد الفرعي بدلاً من جذر المستودع.
|
|
</Note>
|
|
|
|
## متى تستخدم ذلك
|
|
|
|
يكون النشر من monorepo مفيداً عندما يحتوي مستودع واحد على عدة أتمتات أو حزم
|
|
مشتركة أو كود تطبيقات آخر:
|
|
|
|
```text
|
|
company-ai/
|
|
|-- uv.lock
|
|
|-- packages/
|
|
| `-- shared_tools/
|
|
`-- crews/
|
|
|-- support_agent/
|
|
| |-- pyproject.toml
|
|
| |-- crew.jsonc
|
|
| `-- agents/
|
|
| `-- support_agent.jsonc
|
|
`-- research_flow/
|
|
|-- pyproject.toml
|
|
`-- src/
|
|
`-- research_flow/
|
|
`-- main.py
|
|
```
|
|
|
|
لنشر `support_agent`، اضبط دليل العمل على:
|
|
|
|
```text
|
|
crews/support_agent
|
|
```
|
|
|
|
لا يزال AMP يجلب المستودع كاملاً أو يرفعه، لكنه يتعامل مع المجلد المحدد كجذر
|
|
مشروع الأتمتة.
|
|
|
|
## ما الذي يتحكم به دليل العمل
|
|
|
|
عند تعيين دليل عمل، يستخدم AMP ذلك المجلد من أجل:
|
|
|
|
- التحقق من المشروع، بما في ذلك `pyproject.toml` وملفات crew JSON وأي نقطة دخول كلاسيكية لـ Crew أو Flow
|
|
- تثبيت الاعتماديات باستخدام `uv`
|
|
- دليل العمل للعملية قيد التشغيل
|
|
- متغير البيئة `CREW_ROOT_DIR`
|
|
|
|
ترك الحقل فارغاً يحافظ على السلوك الحالي ويستخدم جذر المستودع.
|
|
|
|
## المصادر المدعومة
|
|
|
|
يمكنك تعيين دليل عمل عند إنشاء نشر من:
|
|
|
|
- مستودع GitHub متصل
|
|
- مستودع Git مكوّن في AMP
|
|
- رفع ملف ZIP
|
|
|
|
<Info>
|
|
اضبط أدلة العمل من واجهة AMP على الويب. لا يطلب تدفق CLI
|
|
`crewai deploy create` هذا الحقل.
|
|
</Info>
|
|
|
|
يمكنك أيضاً إضافة دليل العمل أو تغييره في نشر موجود من صفحة **Settings** الخاصة
|
|
بالنشر. يسري التغيير في النشر التالي.
|
|
|
|
<Warning>
|
|
لا يمكن استخدام أدلة العمل وauto-deploy معاً. إذا كان للنشر دليل عمل، يتم
|
|
تعطيل auto-deploy لذلك النشر. أوقف auto-deploy قبل تعيين دليل عمل.
|
|
</Warning>
|
|
|
|
## إعداد نشر جديد
|
|
|
|
<Steps>
|
|
<Step title="افتح Deploy from Code">
|
|
في CrewAI AMP، أنشئ نشراً جديداً واختر المصدر: GitHub أو Git Repository أو
|
|
رفع ZIP.
|
|
</Step>
|
|
|
|
<Step title="اختر المستودع أو الفرع أو ملف ZIP">
|
|
اختر المستودع والفرع اللذين يحتويان على monorepo، أو ارفع ملف ZIP يحتوي
|
|
جذره على محتويات monorepo.
|
|
</Step>
|
|
|
|
<Step title="افتح الإعدادات المتقدمة">
|
|
وسّع قسم **Advanced** في نموذج النشر.
|
|
</Step>
|
|
|
|
<Step title="أدخل دليل العمل">
|
|
أدخل المسار من جذر المستودع إلى مشروع Crew أو Flow:
|
|
|
|
```text
|
|
crews/support_agent
|
|
```
|
|
|
|
لا تضف شرطة مائلة في البداية.
|
|
</Step>
|
|
|
|
<Step title="انشر">
|
|
أضف أي متغيرات بيئة مطلوبة، ثم ابدأ النشر.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## إعداد نشر موجود
|
|
|
|
<Steps>
|
|
<Step title="افتح إعدادات النشر">
|
|
انتقل إلى الأتمتة في AMP وافتح **Settings**.
|
|
</Step>
|
|
|
|
<Step title="أوقف auto-deploy إذا لزم الأمر">
|
|
إذا كان auto-deploy مفعلاً، أوقفه أولاً. لا يكون حقل دليل العمل متاحاً
|
|
أثناء تشغيل auto-deploy.
|
|
</Step>
|
|
|
|
<Step title="عيّن دليل العمل">
|
|
في **Basic settings**، أدخل مسار المجلد الفرعي، مثل:
|
|
|
|
```text
|
|
crews/support_agent
|
|
```
|
|
</Step>
|
|
|
|
<Step title="أعد النشر">
|
|
احفظ الإعداد وأعد نشر الأتمتة. سيتم استخدام دليل العمل الجديد في النشر
|
|
التالي.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## قواعد المسار
|
|
|
|
يجب أن يكون دليل العمل مساراً نسبياً داخل جذر المستودع أو ZIP.
|
|
|
|
| القاعدة | المثال |
|
|
|---------|--------|
|
|
| استخدم مساراً نسبياً | `crews/support_agent` |
|
|
| لا تبدأ بـ `/` | `/crews/support_agent` غير صالح |
|
|
| لا تستخدم مقاطع المسار `.` أو `..` | `crews/../support_agent` غير صالح |
|
|
| استخدم الأحرف والأرقام والشرطات والشرطات السفلية والنقاط والشرطات المائلة فقط | `crews/support agent` غير صالح |
|
|
| اجعل المسار 255 حرفاً أو أقل | يتم رفض المسارات الأطول |
|
|
|
|
يزيل AMP المسافات البيضاء في البداية والنهاية، ويضغط الشرطات المائلة المتكررة،
|
|
ويزيل الشرطة المائلة النهائية. تستخدم القيمة الفارغة جذر المستودع.
|
|
|
|
## ملفات القفل وUV Workspaces
|
|
|
|
يجب أن يحتوي المجلد المحدد على `pyproject.toml` وملفات المشروع المناسبة لنوع
|
|
الأتمتة:
|
|
|
|
- crew بنمط JSON-first: ملف `crew.jsonc` أو `crew.json` مع مجلد `agents/`
|
|
- Crew كلاسيكي أو Flow: مجلد `src/` مع نقطة دخول Python المتوقعة
|
|
|
|
يمكن أن يوجد ملف `uv.lock` أو `poetry.lock` إما في المجلد المحدد أو في جذر
|
|
المستودع.
|
|
|
|
يدعم هذا تخطيطي ملفات القفل الشائعين:
|
|
|
|
<Tabs>
|
|
<Tab title="ملف قفل المشروع">
|
|
```text
|
|
company-ai/
|
|
`-- crews/
|
|
`-- support_agent/
|
|
|-- pyproject.toml
|
|
|-- uv.lock
|
|
|-- crew.jsonc
|
|
`-- agents/
|
|
`-- support_agent.jsonc
|
|
```
|
|
</Tab>
|
|
|
|
<Tab title="ملف قفل workspace">
|
|
```text
|
|
company-ai/
|
|
|-- uv.lock
|
|
|-- packages/
|
|
| `-- shared_tools/
|
|
`-- crews/
|
|
`-- support_agent/
|
|
|-- pyproject.toml
|
|
|-- crew.jsonc
|
|
`-- agents/
|
|
`-- support_agent.jsonc
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
<Tip>
|
|
إذا كانت الأتمتة تستورد حزماً مشتركة من مكان آخر في monorepo، فصرّح بهذه
|
|
الحزم في `pyproject.toml` باستخدام إعدادات UV workspace أو path أو source.
|
|
يشغل AMP الأتمتة من المجلد المحدد، لذلك يجب تثبيت الكود المشترك كاعتمادية
|
|
بدلاً من الاعتماد على وجود جذر المستودع في Python path.
|
|
</Tip>
|
|
|
|
## استكشاف الأخطاء وإصلاحها
|
|
|
|
### لم يتم العثور على دليل العمل
|
|
|
|
تحقق من أن المسار نسبي إلى جذر المستودع أو ZIP. بالنسبة لرفع ZIP، يجب أن
|
|
تتضمن محتويات ZIP مسار دليل العمل تماماً كما أدخلته.
|
|
|
|
### pyproject.toml مفقود
|
|
|
|
يجب أن يشير دليل العمل إلى مجلد مشروع Crew أو Flow، وليس فقط إلى مجلد أب
|
|
يحتوي على عدة مشاريع.
|
|
|
|
### uv.lock أو poetry.lock مفقود
|
|
|
|
اعمل commit لملف قفل إما في مجلد المشروع المحدد أو في جذر المستودع. بالنسبة
|
|
إلى UV workspaces، يتم دعم إبقاء `uv.lock` في جذر workspace.
|
|
|
|
### Auto-Deploy غير متاح
|
|
|
|
يتم تعطيل auto-deploy أثناء تعيين دليل عمل. استخدم إعادة النشر اليدوية أو شغّل
|
|
إعادة النشر من CI/CD باستخدام AMP API.
|
|
|
|
<Card title="النشر على AMP" icon="rocket" href="/ar/enterprise/guides/deploy-to-amp">
|
|
تابع دليل النشر بعد اختيار دليل عمل monorepo.
|
|
</Card>
|