mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +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>
331 lines
15 KiB
Plaintext
331 lines
15 KiB
Plaintext
---
|
|
title: تكامل GitHub
|
|
description: "إدارة المستودعات والمشكلات مع تكامل GitHub لـ CrewAI."
|
|
icon: "github"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
مكّن وكلاءك من إدارة المستودعات والمشكلات والإصدارات عبر GitHub. أنشئ المشكلات وحدّثها، وأدر الإصدارات، وتتبع تطور المشاريع، وبسّط سير عمل تطوير البرمجيات باستخدام الأتمتة المدعومة بالذكاء الاصطناعي.
|
|
|
|
## المتطلبات الأساسية
|
|
|
|
قبل استخدام تكامل GitHub، تأكد من توفر ما يلي:
|
|
|
|
- حساب [CrewAI AMP](https://app.crewai.com) مع اشتراك فعّال
|
|
- حساب GitHub بصلاحيات المستودع المناسبة
|
|
- ربط حساب GitHub الخاص بك عبر [صفحة التكاملات](https://app.crewai.com/crewai_plus/connectors)
|
|
|
|
## إعداد تكامل GitHub
|
|
|
|
### 1. ربط حساب GitHub الخاص بك
|
|
|
|
1. انتقل إلى [تكاملات CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
|
2. ابحث عن **GitHub** في قسم تكاملات المصادقة
|
|
3. انقر على **Connect** وأكمل عملية OAuth
|
|
4. امنح الصلاحيات اللازمة لإدارة المستودعات والمشكلات
|
|
5. انسخ رمز المؤسسة من [إعدادات التكامل](https://app.crewai.com/crewai_plus/settings/integrations)
|
|
|
|
### 2. تثبيت الحزمة المطلوبة
|
|
|
|
```bash
|
|
uv add crewai-tools
|
|
```
|
|
|
|
### 3. إعداد متغير البيئة
|
|
|
|
<Note>
|
|
لاستخدام التكاملات مع `Agent(apps=[])`, يجب تعيين متغير البيئة
|
|
`CREWAI_PLATFORM_INTEGRATION_TOKEN` برمز المؤسسة الخاص بك.
|
|
</Note>
|
|
|
|
```bash
|
|
export CREWAI_PLATFORM_INTEGRATION_TOKEN="your_enterprise_token"
|
|
```
|
|
|
|
أو أضفه إلى ملف `.env`:
|
|
|
|
```
|
|
CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
|
|
```
|
|
|
|
## الإجراءات المتاحة
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="github/create_issue">
|
|
**الوصف:** إنشاء مشكلة في GitHub.
|
|
|
|
**المعاملات:**
|
|
- `owner` (string, مطلوب): المالك - حدد اسم مالك الحساب للمستودع المرتبط بهذه المشكلة. (مثال: "abc").
|
|
- `repo` (string, مطلوب): المستودع - حدد اسم المستودع المرتبط بهذه المشكلة.
|
|
- `title` (string, مطلوب): عنوان المشكلة - حدد عنوان المشكلة المراد إنشاؤها.
|
|
- `body` (string, اختياري): محتوى المشكلة - حدد محتوى نص المشكلة المراد إنشاؤها.
|
|
- `assignees` (string, اختياري): المكلّفون - حدد اسم (أسماء) تسجيل الدخول في GitHub للمكلّفين كمصفوفة من السلاسل النصية لهذه المشكلة. (مثال: `["octocat"]`).
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/update_issue">
|
|
**الوصف:** تحديث مشكلة في GitHub.
|
|
|
|
**المعاملات:**
|
|
- `owner` (string, مطلوب): المالك - حدد اسم مالك الحساب للمستودع المرتبط بهذه المشكلة. (مثال: "abc").
|
|
- `repo` (string, مطلوب): المستودع - حدد اسم المستودع المرتبط بهذه المشكلة.
|
|
- `issue_number` (string, مطلوب): رقم المشكلة - حدد رقم المشكلة المراد تحديثها.
|
|
- `title` (string, مطلوب): عنوان المشكلة - حدد عنوان المشكلة المراد تحديثها.
|
|
- `body` (string, اختياري): محتوى المشكلة - حدد محتوى نص المشكلة المراد تحديثها.
|
|
- `assignees` (string, اختياري): المكلّفون - حدد اسم (أسماء) تسجيل الدخول في GitHub للمكلّفين كمصفوفة من السلاسل النصية لهذه المشكلة. (مثال: `["octocat"]`).
|
|
- `state` (string, اختياري): الحالة - حدد الحالة المحدّثة للمشكلة.
|
|
- الخيارات: `open`, `closed`
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/get_issue_by_number">
|
|
**الوصف:** الحصول على مشكلة بواسطة الرقم في GitHub.
|
|
|
|
**المعاملات:**
|
|
- `owner` (string, مطلوب): المالك - حدد اسم مالك الحساب للمستودع المرتبط بهذه المشكلة. (مثال: "abc").
|
|
- `repo` (string, مطلوب): المستودع - حدد اسم المستودع المرتبط بهذه المشكلة.
|
|
- `issue_number` (string, مطلوب): رقم المشكلة - حدد رقم المشكلة المراد جلبها.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/lock_issue">
|
|
**الوصف:** قفل مشكلة في GitHub.
|
|
|
|
**المعاملات:**
|
|
- `owner` (string, مطلوب): المالك - حدد اسم مالك الحساب للمستودع المرتبط بهذه المشكلة. (مثال: "abc").
|
|
- `repo` (string, مطلوب): المستودع - حدد اسم المستودع المرتبط بهذه المشكلة.
|
|
- `issue_number` (string, مطلوب): رقم المشكلة - حدد رقم المشكلة المراد قفلها.
|
|
- `lock_reason` (string, مطلوب): سبب القفل - حدد سبب قفل محادثة المشكلة أو طلب السحب.
|
|
- الخيارات: `off-topic`, `too heated`, `resolved`, `spam`
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/search_issue">
|
|
**الوصف:** البحث عن المشكلات في GitHub.
|
|
|
|
**المعاملات:**
|
|
- `owner` (string, مطلوب): المالك - حدد اسم مالك الحساب للمستودع المرتبط بهذه المشكلة. (مثال: "abc").
|
|
- `repo` (string, مطلوب): المستودع - حدد اسم المستودع المرتبط بهذه المشكلة.
|
|
- `filter` (object, مطلوب): فلتر بصيغة التعبير العادي المنفصل - OR لمجموعات AND من شروط فردية.
|
|
```json
|
|
{
|
|
"operator": "OR",
|
|
"conditions": [
|
|
{
|
|
"operator": "AND",
|
|
"conditions": [
|
|
{
|
|
"field": "assignee",
|
|
"operator": "$stringExactlyMatches",
|
|
"value": "octocat"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
الحقول المتاحة: `assignee`, `creator`, `mentioned`, `labels`
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/create_release">
|
|
**الوصف:** إنشاء إصدار في GitHub.
|
|
|
|
**المعاملات:**
|
|
- `owner` (string, مطلوب): المالك - حدد اسم مالك الحساب للمستودع المرتبط بهذا الإصدار. (مثال: "abc").
|
|
- `repo` (string, مطلوب): المستودع - حدد اسم المستودع المرتبط بهذا الإصدار.
|
|
- `tag_name` (string, مطلوب): الاسم - حدد اسم وسم الإصدار المراد إنشاؤه. (مثال: "v1.0.0").
|
|
- `target_commitish` (string, اختياري): الهدف - حدد هدف الإصدار. يمكن أن يكون اسم فرع أو SHA لعملية إيداع. الافتراضي هو الفرع الرئيسي. (مثال: "master").
|
|
- `body` (string, اختياري): المحتوى - حدد وصفاً لهذا الإصدار.
|
|
- `draft` (string, اختياري): مسودة - حدد ما إذا كان الإصدار المُنشأ يجب أن يكون مسودة (غير منشور).
|
|
- الخيارات: `true`, `false`
|
|
- `prerelease` (string, اختياري): إصدار تجريبي - حدد ما إذا كان الإصدار المُنشأ يجب أن يكون إصداراً تجريبياً.
|
|
- الخيارات: `true`, `false`
|
|
- `discussion_category_name` (string, اختياري): اسم فئة المناقشة - إذا حُدد، يتم إنشاء مناقشة من الفئة المحددة وربطها بالإصدار.
|
|
- `generate_release_notes` (string, اختياري): ملاحظات الإصدار - حدد ما إذا كان يجب إنشاء ملاحظات الإصدار تلقائياً.
|
|
- الخيارات: `true`, `false`
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/update_release">
|
|
**الوصف:** تحديث إصدار في GitHub.
|
|
|
|
**المعاملات:**
|
|
- `owner` (string, مطلوب): المالك - حدد اسم مالك الحساب للمستودع المرتبط بهذا الإصدار. (مثال: "abc").
|
|
- `repo` (string, مطلوب): المستودع - حدد اسم المستودع المرتبط بهذا الإصدار.
|
|
- `id` (string, مطلوب): معرّف الإصدار - حدد معرّف الإصدار المراد تحديثه.
|
|
- `tag_name` (string, اختياري): الاسم - حدد اسم وسم الإصدار المراد تحديثه. (مثال: "v1.0.0").
|
|
- `target_commitish` (string, اختياري): الهدف - حدد هدف الإصدار. يمكن أن يكون اسم فرع أو SHA لعملية إيداع. الافتراضي هو الفرع الرئيسي. (مثال: "master").
|
|
- `body` (string, اختياري): المحتوى - حدد وصفاً لهذا الإصدار.
|
|
- `draft` (string, اختياري): مسودة - حدد ما إذا كان الإصدار يجب أن يكون مسودة (غير منشور).
|
|
- الخيارات: `true`, `false`
|
|
- `prerelease` (string, اختياري): إصدار تجريبي - حدد ما إذا كان الإصدار يجب أن يكون إصداراً تجريبياً.
|
|
- الخيارات: `true`, `false`
|
|
- `discussion_category_name` (string, اختياري): اسم فئة المناقشة - إذا حُدد، يتم إنشاء مناقشة من الفئة المحددة وربطها بالإصدار.
|
|
- `generate_release_notes` (string, اختياري): ملاحظات الإصدار - حدد ما إذا كان يجب إنشاء ملاحظات الإصدار تلقائياً.
|
|
- الخيارات: `true`, `false`
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/get_release_by_id">
|
|
**الوصف:** الحصول على إصدار بواسطة المعرّف في GitHub.
|
|
|
|
**المعاملات:**
|
|
- `owner` (string, مطلوب): المالك - حدد اسم مالك الحساب للمستودع المرتبط بهذا الإصدار. (مثال: "abc").
|
|
- `repo` (string, مطلوب): المستودع - حدد اسم المستودع المرتبط بهذا الإصدار.
|
|
- `id` (string, مطلوب): معرّف الإصدار - حدد معرّف الإصدار المراد جلبه.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/get_release_by_tag_name">
|
|
**الوصف:** الحصول على إصدار بواسطة اسم الوسم في GitHub.
|
|
|
|
**المعاملات:**
|
|
- `owner` (string, مطلوب): المالك - حدد اسم مالك الحساب للمستودع المرتبط بهذا الإصدار. (مثال: "abc").
|
|
- `repo` (string, مطلوب): المستودع - حدد اسم المستودع المرتبط بهذا الإصدار.
|
|
- `tag_name` (string, مطلوب): الاسم - حدد وسم الإصدار المراد جلبه. (مثال: "v1.0.0").
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/delete_release">
|
|
**الوصف:** حذف إصدار في GitHub.
|
|
|
|
**المعاملات:**
|
|
- `owner` (string, مطلوب): المالك - حدد اسم مالك الحساب للمستودع المرتبط بهذا الإصدار. (مثال: "abc").
|
|
- `repo` (string, مطلوب): المستودع - حدد اسم المستودع المرتبط بهذا الإصدار.
|
|
- `id` (string, مطلوب): معرّف الإصدار - حدد معرّف الإصدار المراد حذفه.
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## أمثلة الاستخدام
|
|
|
|
### إعداد Agent أساسي لـ GitHub
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent with Github capabilities
|
|
github_agent = Agent(
|
|
role="Repository Manager",
|
|
goal="Manage GitHub repositories, issues, and releases efficiently",
|
|
backstory="An AI assistant specialized in repository management and issue tracking.",
|
|
apps=['github'] # All Github actions will be available
|
|
)
|
|
|
|
# Task to create a new issue
|
|
create_issue_task = Task(
|
|
description="Create a bug report issue for the login functionality in the main repository",
|
|
agent=github_agent,
|
|
expected_output="Issue created successfully with issue number"
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[github_agent],
|
|
tasks=[create_issue_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### تصفية أدوات GitHub محددة
|
|
|
|
```python
|
|
|
|
issue_manager = Agent(
|
|
role="Issue Manager",
|
|
goal="Create and manage GitHub issues efficiently",
|
|
backstory="An AI assistant that focuses on issue tracking and management.",
|
|
apps=['github/create_issue']
|
|
)
|
|
|
|
# Task to manage issue workflow
|
|
issue_workflow = Task(
|
|
description="Create a feature request issue and assign it to the development team",
|
|
agent=issue_manager,
|
|
expected_output="Feature request issue created and assigned successfully"
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[issue_manager],
|
|
tasks=[issue_workflow]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### إدارة الإصدارات
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
release_manager = Agent(
|
|
role="Release Manager",
|
|
goal="Manage software releases and versioning",
|
|
backstory="An experienced release manager who handles version control and release processes.",
|
|
apps=['github']
|
|
)
|
|
|
|
# Task to create a new release
|
|
release_task = Task(
|
|
description="""
|
|
Create a new release v2.1.0 for the project with:
|
|
- Auto-generated release notes
|
|
- Target the main branch
|
|
- Include a description of new features and bug fixes
|
|
""",
|
|
agent=release_manager,
|
|
expected_output="Release v2.1.0 created successfully with release notes"
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[release_manager],
|
|
tasks=[release_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### تتبع المشكلات وإدارتها
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
project_coordinator = Agent(
|
|
role="Project Coordinator",
|
|
goal="Track and coordinate project issues and development progress",
|
|
backstory="An AI assistant that helps coordinate development work and track project progress.",
|
|
apps=['github']
|
|
)
|
|
|
|
# Complex task involving multiple GitHub operations
|
|
coordination_task = Task(
|
|
description="""
|
|
1. Search for all open issues assigned to the current milestone
|
|
2. Identify overdue issues and update their priority labels
|
|
3. Create a weekly progress report issue
|
|
4. Lock resolved issues that have been inactive for 30 days
|
|
""",
|
|
agent=project_coordinator,
|
|
expected_output="Project coordination completed with progress report and issue management"
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[project_coordinator],
|
|
tasks=[coordination_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### الحصول على المساعدة
|
|
|
|
<Card title="تحتاج مساعدة؟" icon="headset" href="mailto:support@crewai.com">
|
|
تواصل مع فريق الدعم للحصول على المساعدة في إعداد تكامل GitHub أو
|
|
استكشاف الأخطاء وإصلاحها.
|
|
</Card>
|