mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +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>
97 lines
3.3 KiB
Plaintext
97 lines
3.3 KiB
Plaintext
---
|
|
title: نشر أدوات مخصصة
|
|
description: كيفية بناء وتعبئة ونشر أدواتك الخاصة المتوافقة مع CrewAI على PyPI ليتمكن أي مستخدم CrewAI من تثبيتها واستخدامها.
|
|
icon: box-open
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
نظام الأدوات في CrewAI مصمم للتوسيع. إذا بنيت أداة يمكن أن تفيد الآخرين، يمكنك تعبئتها كمكتبة Python مستقلة ونشرها على PyPI وإتاحتها لأي مستخدم CrewAI — دون الحاجة لطلب سحب إلى مستودع CrewAI.
|
|
|
|
يمشي هذا الدليل عبر العملية الكاملة: تنفيذ عقد الأدوات، وهيكلة حزمتك، والنشر على PyPI.
|
|
|
|
<Note type="info" title="لا تبحث عن النشر؟">
|
|
إذا كنت تحتاج فقط أداة مخصصة لمشروعك، راجع دليل [إنشاء أدوات مخصصة](/ar/learn/create-custom-tools) بدلاً من ذلك.
|
|
</Note>
|
|
|
|
## عقد الأدوات
|
|
|
|
كل أداة CrewAI يجب أن تستوفي إحدى الواجهتين:
|
|
|
|
### الخيار 1: وراثة `BaseTool`
|
|
|
|
ورث من `crewai.tools.BaseTool` وطبّق طريقة `_run`. عرّف `name` و`description` واختياريًا `args_schema` للتحقق من المدخلات.
|
|
|
|
```python
|
|
from crewai.tools import BaseTool
|
|
from pydantic import BaseModel, Field
|
|
|
|
|
|
class GeolocateInput(BaseModel):
|
|
"""Input schema for GeolocateTool."""
|
|
address: str = Field(..., description="The street address to geolocate.")
|
|
|
|
|
|
class GeolocateTool(BaseTool):
|
|
name: str = "Geolocate"
|
|
description: str = "Converts a street address into latitude/longitude coordinates."
|
|
args_schema: type[BaseModel] = GeolocateInput
|
|
|
|
def _run(self, address: str) -> str:
|
|
return f"40.7128, -74.0060"
|
|
```
|
|
|
|
### الخيار 2: استخدام مزخرف `@tool`
|
|
|
|
للأدوات الأبسط، يحوّل مزخرف `@tool` دالة إلى أداة CrewAI. يجب أن تحتوي الدالة على سلسلة توثيق (تُستخدم كوصف الأداة) وتعليقات أنواع.
|
|
|
|
```python
|
|
from crewai.tools import tool
|
|
|
|
|
|
@tool("Geolocate")
|
|
def geolocate(address: str) -> str:
|
|
"""Converts a street address into latitude/longitude coordinates."""
|
|
return "40.7128, -74.0060"
|
|
```
|
|
|
|
### المتطلبات الأساسية
|
|
|
|
بغض النظر عن النهج الذي تستخدمه، يجب أن تحتوي أداتك على:
|
|
|
|
- **`name`** — معرّف قصير ووصفي.
|
|
- **`description`** — يخبر الـ Agent متى وكيف يستخدم الأداة.
|
|
- **`_run`** (BaseTool) أو **جسم الدالة** (@tool) — منطق التنفيذ المتزامن.
|
|
- **تعليقات أنواع** على جميع المعاملات وقيم الإرجاع.
|
|
- إرجاع نتيجة **نصية** (أو شيء يمكن تحويله لنص).
|
|
|
|
## هيكل الحزمة
|
|
|
|
```
|
|
crewai-geolocate/
|
|
├── pyproject.toml
|
|
├── LICENSE
|
|
├── README.md
|
|
└── src/
|
|
└── crewai_geolocate/
|
|
├── __init__.py
|
|
└── tools.py
|
|
```
|
|
|
|
## النشر على PyPI
|
|
|
|
```bash
|
|
# Build the package
|
|
uv build
|
|
|
|
# Publish to PyPI
|
|
uv publish
|
|
```
|
|
|
|
بعد النشر، يمكن للمستخدمين تثبيت أداتك بـ:
|
|
|
|
```bash
|
|
uv add crewai-geolocate
|
|
```
|