mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 05:38:12 +00:00
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>
313 lines
13 KiB
Plaintext
313 lines
13 KiB
Plaintext
---
|
|
title: Integração com GitHub
|
|
description: "Gerenciamento de repositórios e issues com a integração do GitHub para CrewAI."
|
|
icon: "github"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Visão Geral
|
|
|
|
Permita que seus agentes gerenciem repositórios, issues e releases através do GitHub. Crie e atualize issues, gerencie releases, acompanhe o desenvolvimento do projeto e otimize seu fluxo de trabalho de desenvolvimento de software com automação alimentada por IA.
|
|
|
|
## Pré-requisitos
|
|
|
|
Antes de usar a integração do GitHub, assegure-se de ter:
|
|
|
|
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
|
- Uma conta GitHub com permissões adequadas no repositório
|
|
- Conta do GitHub conectada através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
|
|
|
|
## Configurando a Integração com GitHub
|
|
|
|
### 1. Conecte sua conta GitHub
|
|
|
|
1. Acesse [Integrações CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
|
2. Encontre **GitHub** na seção de Integrações de Autenticação
|
|
3. Clique em **Conectar** e complete o fluxo OAuth
|
|
4. Conceda as permissões necessárias para gerenciamento de repositório e issues
|
|
5. Copie seu Token Enterprise em [Configurações de Integração](https://app.crewai.com/crewai_plus/settings/integrations)
|
|
|
|
### 2. Instale o pacote necessário
|
|
|
|
```bash
|
|
uv add crewai-tools
|
|
```
|
|
|
|
## Ações Disponíveis
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="github/create_issue">
|
|
**Descrição:** Cria uma issue no GitHub.
|
|
|
|
**Parâmetros:**
|
|
- `owner` (string, obrigatório): Proprietário - Especifique o nome do proprietário da conta do repositório associado a esta Issue. (exemplo: "abc").
|
|
- `repo` (string, obrigatório): Repositório - Especifique o nome do repositório associado a esta Issue.
|
|
- `title` (string, obrigatório): Título da Issue - Especifique o título da issue a ser criada.
|
|
- `body` (string, opcional): Corpo da Issue - Especifique o conteúdo do corpo da issue a ser criada.
|
|
- `assignees` (string, opcional): Responsáveis - Especifique o login dos responsáveis no GitHub como um array de strings para esta issue. (exemplo: `["octocat"]`).
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/update_issue">
|
|
**Descrição:** Atualiza uma issue no GitHub.
|
|
|
|
**Parâmetros:**
|
|
- `owner` (string, obrigatório): Proprietário - Especifique o nome do proprietário da conta do repositório associado a esta Issue. (exemplo: "abc").
|
|
- `repo` (string, obrigatório): Repositório - Especifique o nome do repositório associado a esta Issue.
|
|
- `issue_number` (string, obrigatório): Número da Issue - Especifique o número da issue a ser atualizada.
|
|
- `title` (string, obrigatório): Título da Issue - Especifique o título da issue a ser atualizada.
|
|
- `body` (string, opcional): Corpo da Issue - Especifique o conteúdo do corpo da issue a ser atualizada.
|
|
- `assignees` (string, opcional): Responsáveis - Especifique o login dos responsáveis no GitHub como um array de strings para esta issue. (exemplo: `["octocat"]`).
|
|
- `state` (string, opcional): Estado - Especifique o estado atualizado da issue.
|
|
- Opções: `open`, `closed`
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/get_issue_by_number">
|
|
**Descrição:** Obtém uma issue pelo número no GitHub.
|
|
|
|
**Parâmetros:**
|
|
- `owner` (string, obrigatório): Proprietário - Especifique o nome do proprietário da conta do repositório associado a esta Issue. (exemplo: "abc").
|
|
- `repo` (string, obrigatório): Repositório - Especifique o nome do repositório associado a esta Issue.
|
|
- `issue_number` (string, obrigatório): Número da Issue - Especifique o número da issue a ser buscada.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/lock_issue">
|
|
**Descrição:** Bloqueia uma issue no GitHub.
|
|
|
|
**Parâmetros:**
|
|
- `owner` (string, obrigatório): Proprietário - Especifique o nome do proprietário da conta do repositório associado a esta Issue. (exemplo: "abc").
|
|
- `repo` (string, obrigatório): Repositório - Especifique o nome do repositório associado a esta Issue.
|
|
- `issue_number` (string, obrigatório): Número da Issue - Especifique o número da issue a ser bloqueada.
|
|
- `lock_reason` (string, obrigatório): Motivo do Bloqueio - Especifique um motivo para bloquear a discussão da issue ou pull request.
|
|
- Opções: `off-topic`, `too heated`, `resolved`, `spam`
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/search_issue">
|
|
**Descrição:** Busca por issues no GitHub.
|
|
|
|
**Parâmetros:**
|
|
- `owner` (string, obrigatório): Proprietário - Especifique o nome do proprietário da conta do repositório associado a esta Issue. (exemplo: "abc").
|
|
- `repo` (string, obrigatório): Repositório - Especifique o nome do repositório associado a esta Issue.
|
|
- `filter` (object, obrigatório): Um filtro em forma normal disjuntiva - OU de grupos E de condições simples.
|
|
```json
|
|
{
|
|
"operator": "OR",
|
|
"conditions": [
|
|
{
|
|
"operator": "AND",
|
|
"conditions": [
|
|
{
|
|
"field": "assignee",
|
|
"operator": "$stringExactlyMatches",
|
|
"value": "octocat"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
Campos disponíveis: `assignee`, `creator`, `mentioned`, `labels`
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/create_release">
|
|
**Descrição:** Cria um release no GitHub.
|
|
|
|
**Parâmetros:**
|
|
- `owner` (string, obrigatório): Proprietário - Especifique o nome do proprietário da conta do repositório associado a este Release. (exemplo: "abc").
|
|
- `repo` (string, obrigatório): Repositório - Especifique o nome do repositório associado a este Release.
|
|
- `tag_name` (string, obrigatório): Nome - Especifique o nome da tag do release a ser criada. (exemplo: "v1.0.0").
|
|
- `target_commitish` (string, opcional): Destino - Especifique o destino do release. Pode ser o nome de um branch ou o SHA de um commit. Padrão é o branch principal. (exemplo: "master").
|
|
- `body` (string, opcional): Descrição - Especifique uma descrição para este release.
|
|
- `draft` (string, opcional): Rascunho - Especifique se o release criado deve ser um rascunho (não publicado).
|
|
- Opções: `true`, `false`
|
|
- `prerelease` (string, opcional): Pré-lançamento - Especifique se o release criado deve ser um pré-lançamento.
|
|
- Opções: `true`, `false`
|
|
- `discussion_category_name` (string, opcional): Nome da Categoria de Discussão - Se especificado, uma discussão da categoria indicada é criada e vinculada ao release. O valor deve ser uma categoria já existente no repositório.
|
|
- `generate_release_notes` (string, opcional): Notas de Release - Especifique se o release criado deve criar automaticamente notas de release usando o nome e a descrição fornecidos.
|
|
- Opções: `true`, `false`
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/update_release">
|
|
**Descrição:** Atualiza um release no GitHub.
|
|
|
|
**Parâmetros:**
|
|
- `owner` (string, obrigatório): Proprietário - Especifique o nome do proprietário da conta do repositório associado a este Release. (exemplo: "abc").
|
|
- `repo` (string, obrigatório): Repositório - Especifique o nome do repositório associado a este Release.
|
|
- `id` (string, obrigatório): ID do Release - Especifique o ID do release a ser atualizado.
|
|
- `tag_name` (string, opcional): Nome - Especifique o nome da tag do release a ser atualizado. (exemplo: "v1.0.0").
|
|
- `target_commitish` (string, opcional): Destino - Especifique o destino do release. Pode ser o nome de um branch ou o SHA de um commit. Padrão é o branch principal. (exemplo: "master").
|
|
- `body` (string, opcional): Descrição - Especifique uma descrição para este release.
|
|
- `draft` (string, opcional): Rascunho - Especifique se o release criado deve ser um rascunho (não publicado).
|
|
- Opções: `true`, `false`
|
|
- `prerelease` (string, opcional): Pré-lançamento - Especifique se o release criado deve ser um pré-lançamento.
|
|
- Opções: `true`, `false`
|
|
- `discussion_category_name` (string, opcional): Nome da Categoria de Discussão - Se especificado, uma discussão da categoria indicada é criada e vinculada ao release. O valor deve ser uma categoria já existente no repositório.
|
|
- `generate_release_notes` (string, opcional): Notas de Release - Especifique se o release criado deve criar automaticamente notas de release usando o nome e a descrição fornecidos.
|
|
- Opções: `true`, `false`
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/get_release_by_id">
|
|
**Descrição:** Obtém um release por ID no GitHub.
|
|
|
|
**Parâmetros:**
|
|
- `owner` (string, obrigatório): Proprietário - Especifique o nome do proprietário da conta do repositório associado a este Release. (exemplo: "abc").
|
|
- `repo` (string, obrigatório): Repositório - Especifique o nome do repositório associado a este Release.
|
|
- `id` (string, obrigatório): ID do Release - Especifique o ID do release a ser recuperado.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/get_release_by_tag_name">
|
|
**Descrição:** Obtém um release pelo nome da tag no GitHub.
|
|
|
|
**Parâmetros:**
|
|
- `owner` (string, obrigatório): Proprietário - Especifique o nome do proprietário da conta do repositório associado a este Release. (exemplo: "abc").
|
|
- `repo` (string, obrigatório): Repositório - Especifique o nome do repositório associado a este Release.
|
|
- `tag_name` (string, obrigatório): Nome - Especifique o nome da tag do release a ser recuperado. (exemplo: "v1.0.0").
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="github/delete_release">
|
|
**Descrição:** Exclui um release no GitHub.
|
|
|
|
**Parâmetros:**
|
|
- `owner` (string, obrigatório): Proprietário - Especifique o nome do proprietário da conta do repositório associado a este Release. (exemplo: "abc").
|
|
- `repo` (string, obrigatório): Repositório - Especifique o nome do repositório associado a este Release.
|
|
- `id` (string, obrigatório): ID do Release - Especifique o ID do release a ser excluído.
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## Exemplos de Uso
|
|
|
|
### Configuração Básica de Agente GitHub
|
|
|
|
```python
|
|
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']
|
|
)
|
|
|
|
# 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()
|
|
```
|
|
|
|
### Filtrando Ferramentas GitHub Específicas
|
|
|
|
```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']
|
|
)
|
|
|
|
# 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()
|
|
```
|
|
|
|
### Gerenciamento de Releases
|
|
|
|
```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()
|
|
```
|
|
|
|
### Acompanhamento e Gerenciamento de Issues
|
|
|
|
```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()
|
|
```
|
|
|
|
### Obtendo Ajuda
|
|
|
|
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
|
Entre em contato com nossa equipe de suporte para auxílio na configuração ou
|
|
solução de problemas com a integração do GitHub.
|
|
</Card>
|