Optimizing the creation of pull requests for Dependabot version updates

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

Qui peut utiliser cette fonctionnalité ?

Users with write access

Dans cet article

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.

Remarque

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.

Exemple 1 : Trois groupes de mise à jour des versions

Dans cet exemple, ledependabot.yml fichier :

  • Créez trois groupes, appelés «production-dependencies», «development-dependencies» et «rubocop».
  • Utilisez patterns et dependency-type pour inclure des dépendances dans le groupe.
  • Utilisez exclude-patterns pour exclure une dépendance (ou plusieurs dépendances) du groupe.
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*"

Par conséquent :

  • Les mises à jour de version sont regroupées par type de dépendance.
  • Les dépendances de développement correspondant au modèle rubocop* sont exclues du groupe development-dependencies .
  • Au lieu de cela, les dépendances de développement correspondant rubocop* seront incluses dans le groupe rubocop. En raison de la commande, la correspondance des dépendances de productionrubocop* sera incluse dans le groupe production-dependencies.
  • Qui plus est, tous les groupes s’appliquent par défaut aux mises à jour de version uniquement, car la clé applies-to est absente.

Exemple 2 : Mises à jour groupées avec dépendances exclues

Dans cet exemple, ledependabot.yml fichier :

  • Créez un groupe appelé « support-dependencies », dans le cadre d’une configuration Bundler personnalisée.
  • Utilisez patterns qui correspond au nom d’une dépendance (ou plusieurs dépendances) pour inclure des dépendances dans le groupe.
  • Utilisez exclude-patterns qui correspond au nom d’une dépendance (ou plusieurs dépendances) pour exclure les dépendances du groupe.
  • Appliquez le regroupement aux mises à jour de version uniquement, car applies-to: version-updates est utilisé.
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-*"

Par conséquent :

  • La majorité des dépendances pour bundler sont consolidées dans le groupe support-dependencies en raison du modèle générique (« * »), à part
  • Les dépendances qui correspondent gc_ruboconfig et gocardless-* sont exclues du groupe, et Dependabot continuent de déclencher des demandes de tirage uniques pour ces dépendances. Cela peut être utile si les mises à jour de ces dépendances doivent être examinées de manière plus approfondie.
  • Pour support-dependencies, Dependabot ne créera que des demandes de tirage pour les mises à jour de version.

Exemple 3 : Demandes de tirage individuelles pour les mises à jour majeures et regroupées pour les mises à jour mineures/correctives

Dans cet exemple, ledependabot.yml fichier :

  • Créez un groupe appelé  « angular ».
  • Utilisez patterns qui correspond au nom d’une dépendance pour inclure des dépendances dans le groupe.
  • Utilisez update-type pour inclure uniquement des mises à jour minor ou patch dans le groupe.
  • Appliquez le regroupement aux mises à jour de version uniquement, car applies-to: version-updates est utilisé.
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"

Par conséquent :

  • Dependabot crée une demande de tirage groupée pour toutes les dépendances Angular qui ont une mise à jour mineure ou corrective.
  • Toutes les mises à jour majeures continueront d’être déclenchées en tant que demandes de tirage individuelles.

Exemple 4 : Demandes de tirage regroupées pour les mises à jour mineures/correctives et aucune demande de tirage pour les mises à jour majeures

Dans cet exemple, ledependabot.yml fichier :

  • Créez trois groupes, appelés «angular» et «minor-and-patch».
  • Utilisez applies-to afin que le premier groupe s’applique uniquement aux mises à jour de version, et le deuxième groupe s’applique uniquement aux mises à jour de sécurité.
  • Utilisez update-type pour inclure uniquement des mises à jour minor ou patch pour les deux groupes.
  • Utilisez une ignore condition pour exclure les mises à jour de major version des @angular* packages .
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"]

Par conséquent :

  • Les mises à jour mineures et correctives des versions pour les dépendances Angular sont regroupées en une seule demande de tirage.
  • Les mises à jour de sécurité mineures et correctives pour les dépendances Angular sont également regroupées en une seule demande de tirage.
  • Dependabot n’ouvre pas automatiquement les demandes de tirage pour les mises à jour majeures pour Angular.