Optimizing the creation of pull requests for Dependabot version updates

Learn how to streamline and efficiently manage your Dependabot pull requests.

¿Quién puede utilizar esta característica?

Users with write access

En este artículo

By default, Dependabot opens a new pull request to update each dependency. When you enable security updates, new pull requests are opened when a vulnerable dependency is found. When you configure version updates for one or more ecosystems, new pull requests are opened when new versions of dependencies are available, with the frequency defined in the dependabot.yml file.

If your project has many dependencies, you might find that you have a very large number of Dependabot pull requests to review and merge, which can quickly become difficult to manage.

There are a couple of customization options you can implement to optimize Dependabot update pull requests to align with your processes, such as:

  • Controlling the frequency with which Dependabot checks for newer versions of your dependencies with schedule.
  • Prioritize meaningful updates with groups.

Controlling the frequency and timings of dependency updates

Dependabot runs its checks for version updates at a frequency set by you in the configuration file, where the required field, schedule.interval, must be set to daily, weekly, monthly, quarterly, semiannually, yearly, or cron (see cronjob).

By default, Dependabot balances its workload by assigning a random time to check and raise pull requests for dependency updates.

However, to reduce distraction, or to better organize time and resources for reviewing and addressing version updates, you might find it useful to modify the frequency and timings. For example, you may prefer Dependabot to run weekly rather than daily checks for updates, and at a time that ensures pull requests are raised before for your team's triage session.

Modifying the frequency and timings for dependency updates

You can use schedule with a combination of options to modify the frequency and timings of when Dependabot checks for version updates.

The example dependabot.yml file below changes the npm configuration to specify that Dependabot should check for version updates to npm dependencies every Tuesday at 02:00 Japanese Standard Time (UTC +09:00).

YAML
# `dependabot.yml` file with
# customized schedule for version updates

version: 2
updates:
  # Keep npm dependencies up to date
  - package-ecosystem: "npm"
    directory: "/"
    # Check the npm registry every week on Tuesday at 02:00 Japan Standard Time (UTC +09:00)
    schedule:
      interval: "weekly"
      day: "tuesday"
      time: "02:00"
      timezone: "Asia/Tokyo"

See also schedule.

Setting up a cooldown period for dependency updates

You can use cooldown with a combination of options to control when Dependabot creates pull requests for version updates.

The example dependabot.yml file below shows a cooldown period being applied to the dependencies requests, numpy, and those prefixed with pandas or django, but not to the dependency called pandas (exact match), which is excluded via the exclude list.

YAML
version: 2
updates:
  - package-ecosystem: "pip"
    directory: "/"
    schedule:
      interval: "daily"
    cooldown:
      default-days: 5
      semver-major-days: 30
      semver-minor-days: 7
      semver-patch-days: 3
      include:
        - "requests"
        - "numpy"
        - "pandas*"
        - "django"
      exclude:
        - "pandas"
  • The number of cooldown days must be between 1 and 90.
  • The maximum allowed items limit in include and exclude lists, which can be used with cooldown, is 150 each.

Nota:

To consider all dependencies for a cooldown period, you can:

  • Omit the include option which applies cooldown to all dependencies.
  • Use "*" in include to apply the cooldown settings to everything. We recommend the use of exclude to only exclude specific dependencies from cooldown settings.

SemVer is supported for most package managers. Updates to new versions for dependencies in cooldown are deferred as follows:

  • Major updates: Delayed by 30 days (semver-major-days: 30).
  • Minor updates: Delayed by 7 days (semver-minor-days: 7).
  • Patch updates: Delayed by 3 days (semver-patch-days: 3).

See also cooldown.

Prioritizing meaningful updates

You can use groups to consolidate updates for multiple dependencies into a single pull request. This helps you focus your review time on higher risk updates, and minimize the time spent reviewing minor version updates. For example, you can combine updates for minor or patch updates for development dependencies into a single pull request, and have a dedicated group for security or version updates that impact a key area of your codebase.

You must configure groups per individual package ecosystem, then you can create multiple groups per package ecosystem using a combination of criteria:

  • Dependabot update type: applies-to
  • Type of dependency: dependency-type.
  • Dependency name: patterns and exclude-patterns
  • Semantic versioning levels: update-types

To see all supported values for each criterion, see groups.

The below examples present several different methods to create groups of dependencies using the criteria.

Ejemplo 1: Tres grupos de actualizaciones de versión

En este ejemplo, el archivo dependabot.yml:

  • Crea tres grupos, denominados "production-dependencies", "development-dependencies" y "rubocop".
  • Usa patterns y dependency-type para incluir dependencias en el grupo.
  • Usa exclude-patterns para excluir una dependencia (o varias dependencias) del grupo.
version: 2
updates:
  # Keep bundler dependencies up to date
  - package-ecosystem: "bundler"
    directory: "/"
    schedule:
      interval: "weekly"
    groups:
      production-dependencies:
        dependency-type: "production"
      development-dependencies:
        dependency-type: "development"
        exclude-patterns:
          - "rubocop*"
      rubocop:
        patterns:
          - "rubocop*"

Como resultado:

  • Las actualizaciones de versión se agrupan por tipo de dependencia.
  • Las dependencias de desarrollo que coinciden con el patrón rubocop* se excluyen del grupo development-dependencies.
  • En su lugar, las dependencias de desarrollo que coinciden con rubocop* se incluirán en el grupo rubocop. Debido a la ordenación, las dependencias de producción que coinciden con rubocop* se incluirán en el grupo production-dependencies.
  • Además, de manera predeterminada todos los grupos solo se aplican a las actualizaciones de versión, ya que falta la clave applies-to.

Ejemplo 2: Actualizaciones agrupadas con dependencias excluidas

En este ejemplo, el archivo dependabot.yml:

  • Crea un grupo denominado "support-dependencies", como parte de una configuración de Bundler personalizada.
  • Usa patterns que coincide con el nombre de una dependencia (o varias dependencias) para incluir dependencias en el grupo.
  • Usa exclude-patterns que coincide con el nombre de una dependencia (o varias dependencias) para excluir dependencias del grupo.
  • Aplica la agrupación solo a las actualizaciones de versión, ya que se usa applies-to: version-updates.
version: 2
updates:
  # Keep bundler dependencies up to date
  - package-ecosystem: "bundler"
    directories:
      - "/frontend"
      - "/backend"
      - "/admin"

    schedule:
      interval: "weekly"
    # Create a group of dependencies to be updated together in one pull request
    groups:
      # Specify a name for the group, which will be used in pull request titles
      # and branch names
      support-dependencies:
        # Define patterns to include dependencies in the group (based on
        # dependency name)
        applies-to: version-updates # Applies the group rule to version updates
        patterns:
          - "rubocop" # A single dependency name
          - "rspec*"  # A wildcard string that matches multiple dependency names
          - "*"       # A wildcard that matches all dependencies in the package
                      # ecosystem. Note: using "*" may open a large pull request
        # Define patterns to exclude dependencies from the group (based on
        # dependency name)
        exclude-patterns:
          - "gc_ruboconfig"
          - "gocardless-*"

Como resultado:

  • La mayoría de las dependencias del agrupador se consolidan en el grupo support-dependencies debido al patrón de comodín ("*"), aparte de
  • Las dependencias que coinciden con gc_ruboconfig y gocardless-* se excluyen del grupo y Dependabot continúa con la generación de solicitudes de cambios únicas para estas dependencias. Esto puede resultar útil si es necesario revisar las actualizaciones de estas dependencias con un examen más detallado.
  • Para support-dependencies, Dependabot solo generará solicitudes de cambios para actualizaciones de versión.

Ejemplo 3: Solicitudes de cambios individuales para actualizaciones principales y agrupadas para actualizaciones secundarias o de revisión

En este ejemplo, el archivo dependabot.yml:

  • Crea un grupo denominado "angular".
  • Usa patterns que coincide con el nombre de una dependencia para incluir dependencias en el grupo.
  • Usa update-type para incluir solo actualizaciones de minor o patch en el grupo.
  • Aplica la agrupación solo a las actualizaciones de versión, ya que se usa applies-to: version-updates.
version: 2
updates:
  - package-ecosystem: "npm"
    directory: "/"
    schedule:
      interval: "weekly"
    groups:
      # Specify a name for the group, which will be used in pull request titles
      # and branch names
      angular:
        applies-to: version-updates
        patterns:
          - "@angular*"
        update-types:
          - "minor"
          - "patch"

Como resultado:

  • Dependabot creará una solicitud de cambios agrupada para todas las dependencias de Angular que tengan una actualización secundaria o de revisión.
  • Todas las actualizaciones principales se seguirán generando como solicitudes de cambios individuales.

Ejemplo 4: Solicitudes de cambios agrupadas para actualizaciones secundarias o de revisión, y sin solicitudes de cambios para las actualizaciones principales

En este ejemplo, el archivo dependabot.yml:

  • Crea dos grupos denominados "angular" y "minor-and-patch".
  • Usa applies-to para que el primer grupo solo se aplique a las actualizaciones de versión y el segundo solo a las actualizaciones de seguridad.
  • Usa update-type para incluir solo actualizaciones de minor o patch para ambos grupos.
  • Usa una condición ignore para excluir las actualizaciones de versiones major de paquetes @angular*.
version: 2
updates:
  # Keep npm dependencies up to date
  - package-ecosystem: "npm"
    directory: "/"
    schedule:
      interval: "weekly"
    groups:
      angular:
        applies-to: version-updates
        patterns:
          - "@angular*"
        update-types:
          - "minor"
          - "patch"
      minor-and-patch:
        applies-to: security-updates
        patterns:
          - "@angular*"
        update-types:
          - "patch"
          - "minor"
    ignore:
      - dependency-name: "@angular*"
        update-types: ["version-update:semver-major"]

Como resultado:

  • Las actualizaciones de versiones secundarias y de revisión para las dependencias de Angular se agrupan en una única solicitud de cambios.
  • Las actualizaciones de versiones secundarias y de revisión para las dependencias de Angular también se agrupan en una única solicitud de cambios.
  • Dependabot no abrirá automáticamente solicitudes de cambios para las actualizaciones principales de Angular.