kedgeway

Documentación / Uso / CI

CI

Usa --fail-on para convertir los hallazgos en un código de salida de error.

Códigos de salida

  • 0: terminó, no hay nada en el umbral ni por encima.
  • 1: error de la herramienta. Trátalo como una falla de infraestructura.
  • 2: un hallazgo alcanzó el umbral. Esta es la señal de desfase.

Elige el umbral según qué tan estricto quieras ser: --fail-on critical falla con SDK obsoletos y paquetes heredados; --fail-on warning también falla cuando hay un major de atraso y con los desconocidos.

Datos en vivo en CI

Exporta tu inicio de sesión de Raven guardado una sola vez, en una máquina donde hayas iniciado sesión, y guárdalo como secreto del repositorio:

Terminal
kedgeway login --export | pbcopy   # macOS; use xclip or wl-copy elsewhere

Crea un secreto llamado KEDGEWAY_AUTH con ese valor (Settings, Secrets and variables, Actions). En la GitHub Action pásalo como auth: ${{ secrets.KEDGEWAY_AUTH }}. Fuera de la action, define tú mismo la variable de entorno KEDGEWAY_AUTH.

¿Prefieres no usar ningún secreto? Ejecuta sin conexión contra un snapshot guardado con --fixture y actualízalo a mano. Consulta Fixtures. La action necesita una de las dos: auth o fixture.

Ejemplo con GitHub Actions

Instala la CLI publicada y revisa el repo contra un fixture incluido en un commit. Para la action mantenida, consulta GitHub Action.

yaml
name: kedgeway
on: [push, pull_request]
jobs:
  diagnose:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
      - run: npm install -g kedgeway
      - run: kedgeway diagnose . --fail-on warning --fixture snapshot.json

El paso diagnose sale con 2 cuando existe un hallazgo warning o critical, y con 1 ante un error de la herramienta. Haz commit de snapshot.json junto al workflow, o quita --fixture y define KEDGEWAY_AUTH en el entorno del paso para usar datos en vivo.