Mejora la calidad de tu código con Code Climate
¿Te gustaría tener una herramienta que revise tu código automáticamente y te diga qué puedes mejorar? ¿O ver qué tanto cubren tus pruebas unitarias? Para eso está Code Climate, y en esta guía te explicamos paso a paso cómo configurarlo en tu proyecto de GitHub usando GitHub Actions.
Paso 1: Regístrate en Code Climate
Ve a codeclimate.com y elige Quality (la opción para analizar la calidad del código).
Inicia sesión con tu cuenta de GitHub.
Selecciona Open Source (código abierto). Esta opción es gratuita para proyectos públicos.
Elige el repositorio que quieres analizar.
Paso 2: Conecta Code Climate con GitHub Action
- En Code Climate, entra al repositorio que conectaste y ve a:
- Repo Settings → Test coverage.
Copia el valor llamado Test Reporter ID (lo vas a usar pronto)
- Ahora abre tu repositorio en GitHub y haz esto:
- Settings → Secrets and variables → Actions → New repository secret.
- Crea un nuevo secreto con:
- Name: CC_TEST_REPORTER_ID
- Value: pega aquí el ID que copiaste antes
Paso 3: Agrega el archivo de configuración
- En tu proyecto, crea esta carpeta si aún no existe:
- .github/workflows/
- Dentro de esa carpeta, agrega un archivo llamado main.yml.
- Puedes usar esta plantilla de ejemplo de Hexlet.
- Busca las líneas del archivo relacionadas con cobertura de pruebas y descoméntalas (quita el # del inicio).
- Asegúrate de que esté usando correctamente el secreto CC_TEST_REPORTER_ID.
🔄 Paso 4: Genera los informes de cobertura
Para que Code Climate reciba tus datos de pruebas, tu proyecto debe generar un archivo de cobertura. Aquí te damos una guía para proyectos en Java con Gradle:
Para que Code Climate reciba tus datos de pruebas, tu proyecto debe generar un archivo de cobertura. Aquí te damos una guía para proyectos en Java con Gradle:
- En tu archivo build.gradle, activa el plugin de cobertura:
- groovy
- CopyEdit
- apply plugin: 'jacoco'
- Asegúrate de que se genere un archivo .xml con los resultados.
- Puedes usar un comando tipo make test o gradle test para generar el informe.
- 🏅 Paso 5: Muestra tu calidad con orgullo
- Vuelve a Code Climate y abre Repo Settings.
- Copia el código Markdown de las insignias de:
- Calidad del código (Maintainability)
- Cobertura de pruebas (Test Coverage)
- Pega ese código en tu archivo README.md.
- ✅ ¡Así, todo el mundo podrá ver lo bien cuidado que está tu proyecto!
Leer otros artículos de Blog
Lee otros artículos relevantes del mundo de la tecnología y el espíritu empresarial.