mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-03 14:09:24 +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>
249 lines
9.0 KiB
Plaintext
249 lines
9.0 KiB
Plaintext
---
|
|
title: تكامل Jira
|
|
description: "تتبع المشكلات وإدارة المشاريع مع تكامل Jira لـ CrewAI."
|
|
icon: "bug"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
مكّن وكلاءك من إدارة المشكلات والمشاريع وسير العمل عبر Jira. أنشئ المشكلات وحدّثها، وتتبع تقدم المشاريع، وأدر التعيينات، وبسّط إدارة مشاريعك باستخدام الأتمتة المدعومة بالذكاء الاصطناعي.
|
|
|
|
## المتطلبات الأساسية
|
|
|
|
قبل استخدام تكامل Jira، تأكد من توفر ما يلي:
|
|
|
|
- حساب [CrewAI AMP](https://app.crewai.com) مع اشتراك فعّال
|
|
- حساب Jira بصلاحيات المشروع المناسبة
|
|
- ربط حساب Jira الخاص بك عبر [صفحة التكاملات](https://app.crewai.com/crewai_plus/connectors)
|
|
|
|
## إعداد تكامل Jira
|
|
|
|
### 1. ربط حساب Jira الخاص بك
|
|
|
|
1. انتقل إلى [تكاملات CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
|
2. ابحث عن **Jira** في قسم تكاملات المصادقة
|
|
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="jira/create_issue">
|
|
**الوصف:** إنشاء مشكلة في Jira.
|
|
|
|
**المعاملات:**
|
|
- `summary` (string, مطلوب): الملخص - ملخص موجز من سطر واحد للمشكلة. (مثال: "The printer stopped working").
|
|
- `project` (string, اختياري): المشروع - المشروع الذي تنتمي إليه المشكلة.
|
|
- `issueType` (string, اختياري): نوع المشكلة - الافتراضي هو Task.
|
|
- `jiraIssueStatus` (string, اختياري): الحالة - الافتراضي هو أول حالة في المشروع.
|
|
- `assignee` (string, اختياري): المكلّف - الافتراضي هو المستخدم المصادق عليه.
|
|
- `description` (string, اختياري): الوصف - وصف تفصيلي للمشكلة.
|
|
- `additionalFields` (string, اختياري): حقول إضافية - حدد أي حقول أخرى بصيغة JSON.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="jira/update_issue">
|
|
**الوصف:** تحديث مشكلة في Jira.
|
|
|
|
**المعاملات:**
|
|
- `issueKey` (string, مطلوب): مفتاح المشكلة (مثال: "TEST-1234").
|
|
- `summary` (string, اختياري): الملخص.
|
|
- `issueType` (string, اختياري): نوع المشكلة.
|
|
- `jiraIssueStatus` (string, اختياري): الحالة.
|
|
- `assignee` (string, اختياري): المكلّف.
|
|
- `description` (string, اختياري): الوصف.
|
|
- `additionalFields` (string, اختياري): حقول إضافية بصيغة JSON.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="jira/get_issue_by_key">
|
|
**الوصف:** الحصول على مشكلة بواسطة المفتاح في Jira.
|
|
|
|
**المعاملات:**
|
|
- `issueKey` (string, مطلوب): مفتاح المشكلة (مثال: "TEST-1234").
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="jira/filter_issues">
|
|
**الوصف:** البحث عن المشكلات في Jira باستخدام الفلاتر.
|
|
|
|
**المعاملات:**
|
|
- `jqlQuery` (object, اختياري): فلتر بصيغة التعبير العادي المنفصل.
|
|
- `limit` (string, اختياري): حدود النتائج - الافتراضي 10.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="jira/search_by_jql">
|
|
**الوصف:** البحث عن المشكلات بواسطة JQL في Jira.
|
|
|
|
**المعاملات:**
|
|
- `jqlQuery` (string, مطلوب): استعلام JQL (مثال: "project = PROJECT").
|
|
- `paginationParameters` (object, اختياري): معاملات الترقيم.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="jira/describe_action_schema">
|
|
**الوصف:** الحصول على المخطط المتوقع لنوع مشكلة.
|
|
|
|
**المعاملات:**
|
|
- `issueTypeId` (string, مطلوب): معرّف نوع المشكلة.
|
|
- `projectKey` (string, مطلوب): مفتاح المشروع.
|
|
- `operation` (string, مطلوب): نوع العملية، مثال CREATE_ISSUE أو UPDATE_ISSUE.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="jira/get_projects">
|
|
**الوصف:** الحصول على المشاريع في Jira.
|
|
|
|
**المعاملات:**
|
|
- `paginationParameters` (object, اختياري): معاملات الترقيم.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="jira/get_issue_types_by_project">
|
|
**الوصف:** الحصول على أنواع المشكلات بواسطة المشروع في Jira.
|
|
|
|
**المعاملات:**
|
|
- `project` (string, مطلوب): مفتاح المشروع.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="jira/get_issue_types">
|
|
**الوصف:** الحصول على جميع أنواع المشكلات في Jira.
|
|
|
|
**المعاملات:** لا توجد معاملات مطلوبة.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="jira/get_issue_status_by_project">
|
|
**الوصف:** الحصول على حالات المشكلات لمشروع معين.
|
|
|
|
**المعاملات:**
|
|
- `project` (string, مطلوب): مفتاح المشروع.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="jira/get_all_assignees_by_project">
|
|
**الوصف:** الحصول على المكلّفين لمشروع معين.
|
|
|
|
**المعاملات:**
|
|
- `project` (string, مطلوب): مفتاح المشروع.
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## أمثلة الاستخدام
|
|
|
|
### إعداد Agent أساسي لـ Jira
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent with Jira capabilities
|
|
jira_agent = Agent(
|
|
role="Issue Manager",
|
|
goal="Manage Jira issues and track project progress efficiently",
|
|
backstory="An AI assistant specialized in issue tracking and project management.",
|
|
apps=['jira'] # All Jira actions will be available
|
|
)
|
|
|
|
# Task to create a bug report
|
|
create_bug_task = Task(
|
|
description="Create a bug report for the login functionality with high priority and assign it to the development team",
|
|
agent=jira_agent,
|
|
expected_output="Bug report created successfully with issue key"
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[jira_agent],
|
|
tasks=[create_bug_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### تحليل المشاريع وإعداد التقارير
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
project_analyst = Agent(
|
|
role="Project Analyst",
|
|
goal="Analyze project data and generate insights from Jira",
|
|
backstory="An experienced project analyst who extracts insights from project management data.",
|
|
apps=['jira']
|
|
)
|
|
|
|
# Task to analyze project status
|
|
analysis_task = Task(
|
|
description="""
|
|
1. Get all projects and their issue types
|
|
2. Search for all open issues across projects
|
|
3. Analyze issue distribution by status and assignee
|
|
4. Create a summary report issue with findings
|
|
""",
|
|
agent=project_analyst,
|
|
expected_output="Project analysis completed with summary report created"
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[project_analyst],
|
|
tasks=[analysis_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
## استكشاف الأخطاء وإصلاحها
|
|
|
|
### المشاكل الشائعة
|
|
|
|
**أخطاء الصلاحيات**
|
|
|
|
- تأكد من أن حساب Jira الخاص بك لديه الصلاحيات اللازمة للمشاريع المستهدفة
|
|
- تحقق من أن اتصال OAuth يتضمن النطاقات المطلوبة لـ Jira API
|
|
|
|
**مفاتيح المشاريع أو المشكلات غير الصالحة**
|
|
|
|
- تحقق جيداً من مفاتيح المشاريع ومفاتيح المشكلات للتأكد من صحة الصيغة (مثال: "PROJ-123")
|
|
- تأكد من وجود المشاريع وإمكانية الوصول إليها من حسابك
|
|
|
|
**مشاكل استعلام JQL**
|
|
|
|
- اختبر استعلامات JQL في بحث مشكلات Jira قبل استخدامها في استدعاءات API
|
|
- تأكد من صحة إملاء أسماء الحقول في JQL ووجودها في مثيل Jira الخاص بك
|
|
|
|
### الحصول على المساعدة
|
|
|
|
<Card title="تحتاج مساعدة؟" icon="headset" href="mailto:support@crewai.com">
|
|
تواصل مع فريق الدعم للحصول على المساعدة في إعداد تكامل Jira أو
|
|
استكشاف الأخطاء وإصلاحها.
|
|
</Card>
|