Integración de Codex con GitHub
Codex se integra profundamente con GitHub, permitiendo realizar revisiones de código directamente en las solicitudes de extracción. Esta sección detalla cómo configurar y usar la integración de GitHub.
Descripción general de funciones
Con la integración de GitHub, puedes:
- Solicitar una revisión de Codex directamente en los comentarios de PR
- Revisar automáticamente cada solicitud de extracción
- Hacer que Codex corrija los fallos de CI
- Ver los cambios de código y proporcionar sugerencias
Sin necesidad de salir de GitHub, Codex responderá con comentarios de revisión como un compañero de equipo.
Configurar la integración de GitHub
Requisitos previos
- Suscripción a Codex Cloud
- Cuenta de GitHub
Pasos de configuración
- ConfiguraciónCodex Cloud
- Ir aConfiguración de Codex
- Habilitar para el repositorioCode reviewFunciones
- Autoriza a Codex para acceder a tus repositorios
Debes otorgar a Codex permisos para leer repositorios y crear solicitudes de extracción.
Solicitar revisión de código
Activar revisión manualmente
Menciona en el comentario de la solicitud de extracción@codex review：
Solicitar revisión
# Escribe en el comentario del PR
@codex review
# O especifica el enfoque de la revisión
@codex review for security regressions
@codex review
# O especifica el enfoque de la revisión
@codex review for security regressions
Respuesta de Codex
Codex:
- Reaccionará al PR (👀)
- Analizará los cambios de código
- Publicará comentarios de revisión
- Marcará los problemas encontrados (P0 y P1)
Codex publicará comentarios de revisión en el PR como un revisor humano.
Revisión automática
Activar en la configuraciónAutomatic reviews：
- Ir aConfiguración de Codex
- ActivarAutomatic reviews
- Publicar automáticamente una revisión cuando se abra un nuevo PR
Personalizar el contenido de la revisión
Establecer guías de revisión del repositorio
En el repositorioAGENTS.mdagrega la guía de revisión:
Agregar guía de revisión
## Review guidelines
- No registres PII (información de identificación personal)
- Verify that authentication middleware wraps every route
- Check for SQL injection vulnerabilities
- Ensure error messages don't leak sensitive information
- No registres PII (información de identificación personal)
- Verify that authentication middleware wraps every route
- Check for SQL injection vulnerabilities
- Ensure error messages don't leak sensitive information
Reglas específicas del módulo
Coloca reglas de revisión más específicas en subdirectorios:
Reglas específicas del módulo
# Reglas de revisión del módulo src/payment/
## Payment-specific reviews
- Verify payment processing follows PCI compliance
- Check for proper amount validation
- Ensure transaction logging
## Payment-specific reviews
- Verify payment processing follows PCI compliance
- Check for proper amount validation
- Ensure transaction logging
Las reglas más específicas se aplicarán automáticamente a los cambios de código del módulo correspondiente.
Enfoque de revisión único
Especifica el enfoque de revisión en el comentario:
Especificar el enfoque de revisión
# Ejemplo de comentario
@codex review for security issues
@codex review for performance regressions
@codex review for documentation completeness
@codex review for security issues
@codex review for performance regressions
@codex review for documentation completeness
Dar otras tareas a Codex
Mencionar en el comentario@codex(no review) iniciará una tarea en la nube:
Otras tareas
# Corregir fallos de CI
@codex fix the CI failures
# Agregar pruebas
@codex add tests for the new API endpoints
# Refactorizar código
@codex refactor this function to use async/await
@codex fix the CI failures
# Agregar pruebas
@codex add tests for the new API endpoints
# Refactorizar código
@codex refactor this function to use async/await
Usar otras funciones de Codex es tan simple como mencionarlo con @ en un comentario.
Integración con GitHub Actions
También puedes usar Codex en GitHub Actions:
Flujo de trabajo de GitHub Actions
span style="color: green;">
name: Codex Review
on: [pull_request]
jobs:
codex-review:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run Codex Review
run: |
codex exec "Review code changes in this PR" --output review.md
- name: Post Review
uses: actions/github-script@v7
with:
script: |
const fs = require('fs');
const review = fs.readFileSync('review.md', 'utf8');
github.rest.pulls.createReview({
owner: context.repo.owner,
repo: context.repo.repo,
pull_number: context.issue.number,
body: review,
event: 'COMMENT'
});
name: Codex Review
on: [pull_request]
jobs:
codex-review:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run Codex Review
run: |
codex exec "Review code changes in this PR" --output review.md
- name: Post Review
uses: actions/github-script@v7
with:
script: |
const fs = require('fs');
const review = fs.readFileSync('review.md', 'utf8');
github.rest.pulls.createReview({
owner: context.repo.owner,
repo: context.repo.repo,
pull_number: context.issue.number,
body: review,
event: 'COMMENT'
});
Integrar Codex en el flujo de CI/CD puede automatizar la revisión de código.
Mejores prácticas
Guía de revisión
- Define claramente los estándares de revisión en AGENTS.md
- Establece reglas específicas para diferentes módulos
- Especifica la prioridad de los problemas (P0/P1)
Automatización
- Activa la revisión automática para PR habituales
- Usa activación manual para cambios grandes
- Úsalo junto con flujos de trabajo automatizados
Una buena configuración puede hacer que la revisión de Codex sea más precisa y eficiente.
Preguntas frecuentes
Q: ¿La revisión de Codex requiere pago?
La integración con GitHub requiere una suscripción a Codex Cloud.
Q: ¿Puede Codex acceder a repositorios privados?
Es necesario autorizar a Codex para acceder a tus repositorios privados.
Q: ¿Se pueden limitar los repositorios que Codex revisa?
Sí, puedes autorizar repositorios de forma selectiva en la configuración.
Q: ¿Qué niveles de problemas marca Codex?
Por defecto marca problemas P0 (críticos) y P1 (importantes).
Otras extensiones