Saltar al contenido

Configuración de Dependabot que no abruma a su equipo

Última actualización

Dependabot abre pull requests cuando sus dependencias tienen nuevas versiones o correcciones de seguridad. Con la configuración predeterminada, en un repositorio muy activo genera un flujo de PR pequeños que la gente acaba ignorando, lo que anula su propósito. Esta guía explica cómo configurarlo para que las actualizaciones lleguen agrupadas en unas pocas PR, las correcciones de seguridad sigan siendo rápidas y las actualizaciones de bajo riesgo se fusionen solas.

Dos tipos de actualizaciones

  • Las actualizaciones de seguridad se abren cuando una dependencia tiene una vulnerabilidad conocida (según la GitHub Advisory Database). Se activan en la configuración del repositorio, en Advisories and Dependabot alerts. No las controla la programación del archivo de configuración.
  • Las actualizaciones de versión se abren para nuevas versiones tengan o no una vulnerabilidad, según dependabot.yml.

Conviene tratarlas de forma distinta. Las actualizaciones de seguridad deben revisarse y fusionarse con rapidez. Las actualizaciones de versión pueden agruparse y espaciarse.

Una configuración inicial recomendable

Cree .github/dependabot.yml:

version: 2
updates:
  - package-ecosystem: "npm"
    directory: "/"
    schedule:
      interval: "weekly"
      day: "monday"
      time: "06:00"
      timezone: "Europe/London"
    open-pull-requests-limit: 5
    groups:
      dev-dependencies:
        dependency-type: "development"
        update-types: ["minor", "patch"]
      production-minor-patch:
        dependency-type: "production"
        update-types: ["minor", "patch"]
    ignore:
      - dependency-name: "*"
        update-types: ["version-update:semver-major"]
    labels: ["dependencies"]
    commit-message:
      prefix: "chore(deps)"

  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      interval: "monthly"
    groups:
      actions:
        patterns: ["*"]

Genere una para sus stacks con el generador de configuración de Dependabot.

Los cinco ajustes que reducen el ruido

1. Programación. weekly es una buena opción predeterminada; monthly para repositorios con cambios lentos. Rara vez merece la pena el modo diario. Un día y una hora fijos hacen que las PR aparezcan cuando el equipo las espera.

2. Grupos. Sin agrupación, 15 actualizaciones de dependencias de desarrollo son 15 PR, 15 ejecuciones de CI y 15 fusiones. Con grupos, son una sola. Agrupe por tipo de dependencia, por tipo de actualización o por patrón de nombre (patterns: ["eslint", "@typescript-eslint/"]). Dependabot solo agrupa actualizaciones del mismo ecosistema y directorio, y la PR de un grupo se abre con las actualizaciones de versión que toque.

3. Ignore las versiones mayores por defecto. Las versiones mayores suelen requerir cambios en el código. Ignórelas en la configuración y actualícelas después de forma deliberada, como trabajo planificado. También puede ignorar una dependencia concreta hasta que esté preparado:

ignore:
  - dependency-name: "react"
    versions: [">=19"]

4. Periodo de espera. La opción cooldown retrasa una nueva versión antes de que Dependabot la proponga. Muchas versiones maliciosas o defectuosas se detectan y retiran en pocos días, así que esa demora evita la mayoría de ellas:

cooldown:
  default-days: 5
  semver-major-days: 30
  semver-minor-days: 7
  semver-patch-days: 3

Consulte la referencia actual de opciones de Dependabot para saber qué ecosistemas admiten cooldown, y tenga en cuenta que las actualizaciones de seguridad no se retrasan con esta opción.

5. Límite de PR abiertas. open-pull-requests-limit tiene por defecto 5 para las actualizaciones de versión. Redúzcalo si la cola de CI se congestiona. Si lo establece en 0, desactiva las actualizaciones de versión para esa entrada (las actualizaciones de seguridad no se ven afectadas).

Reduzca el coste de CI

Cada PR de Dependabot ejecuta su CI completo. Para mitigarlo:

  • Agrupe las actualizaciones (véase más arriba), de modo que una sola ejecución cubra muchas actualizaciones.
  • Use concurrency con cancel-in-progress para que las PR rebaseadas no acumulen ejecuciones.
  • Ejecute comprobaciones más ligeras en las PR de dependencias, por ejemplo solo las pruebas unitarias, y deje la suite completa para la merge queue. Consulte GitHub merge queue.
  • Programe las actualizaciones en un momento en que el CI esté libre.

Use el previsor de minutos de CI para ver lo que cuestan 20 PR adicionales a la semana.

Fusione automáticamente las seguras

Active la fusión automática de las actualizaciones de parche y menores de las dependencias de desarrollo cuando el CI pase. Un workflow que use dependabot/fetch-metadata lee el tipo de actualización:

name: dependabot-auto-merge
on: pull_request
permissions:
  contents: write
  pull-requests: write
jobs:
  auto:
    if: github.actor == 'dependabot[bot]'
    runs-on: ubuntu-latest
    steps:
      - id: meta
        uses: dependabot/fetch-metadata@v2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
      - if: steps.meta.outputs.update-type != 'version-update:semver-major'
        run: gh pr merge --auto --squash "$PR_URL"
        env:
          PR_URL: ${{ github.event.pull_request.html_url }}
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

La fusión solo se produce cuando pasan las comprobaciones requeridas, así que la protección de ramas y las buenas pruebas son lo que la hace segura. Active «Allow auto-merge» en la configuración del repositorio. Fije dependabot/fetch-metadata a un SHA, como se describe en cómo proteger GitHub Actions. Nunca fusione automáticamente nada que afecte a dependencias de producción sin una cobertura de pruebas en la que confíe.

Mantenga GitHub Actions fijadas y actualizadas

Añada el ecosistema github-actions como se muestra arriba. Dependabot actualiza tanto las referencias por etiqueta como las fijadas por SHA; con los SHA mantiene actualizado el comentario # v3.5.2 que las acompaña. Así puede fijar por SHA sin la carga de mantenimiento.

Enrutamiento y responsabilidad

Las PR necesitan un responsable, o nadie las revisará. En lugar de las opciones obsoletas reviewers y assignees de dependabot.yml, use CODEOWNERS para solicitar la revisión a un equipo, y etiquetas para filtrar. Rote semanalmente el rol de «responsable de dependencias» y mantenga una regla sencilla: fusione el mismo día los parches en verde y programe las versiones mayores.

Monorepos y varios directorios

Dependabot necesita una entrada updates por ecosistema y directorio. Si tiene muchos directorios, use directories (una lista o un glob) para no repetir el bloque:

- package-ecosystem: "npm"
  directories: ["/", "/apps/*", "/packages/*"]
  schedule:
    interval: "weekly"

Los grupos reúnen entonces las actualizaciones de esos directorios en los que se actualiza la misma dependencia. Consulte la versión de la documentación de Dependabot que use para ver cómo se forman los grupos de varios directorios.

Preguntas frecuentes

¿Cuántas PR de Dependabot son demasiadas?

Si las PR llevan abiertas más de una semana, son demasiadas. Ajuste la programación, agrupe más y reduzca los ecosistemas ignorados.

¿Dependabot tiene coste?

Dependabot es gratuito. Sus PR ejecutan su CI, así que consumen minutos de Actions.

¿Debería usar Renovate en su lugar?

Renovate ofrece más opciones de configuración y funciona en varias plataformas. Dependabot está integrado en GitHub y no requiere alojamiento. Ambos admiten agrupación y programación; elija según las funciones que necesite.

¿Puedo silenciar una actualización durante un tiempo?

Sí, comente @dependabot ignore this minor version o use entradas ignore. También puede usar cooldown para ralentizar todas las actualizaciones.

Un CI más rápido hace que las PR de dependencias sean más económicas de procesar: el modo de comparación de compiler.dev muestra cuánto cuesta su flujo de pruebas en runners más rápidos, lo que resulta útil cuando recibe muchas PR automatizadas.

Ejecute este workflow en compiler.dev Sin tarjeta · 200 minutos gratuitos

Pruébelo gratis