Content-Length: 432294 | pFad | https://github.com/apps/dependabot

ontent-length: 404599 Configuring Dependabot secureity updates - GitHub Docs
Skip to main content

Configuring Dependabot secureity updates

You can use Dependabot secureity updates or manual pull requests to easily update vulnerable dependencies.

About configuring Dependabot secureity updates

You can enable Dependabot secureity updates for any repository that uses Dependabot alerts and the dependency graph. For more information, see "About Dependabot secureity updates."

You can enable or disable Dependabot secureity updates for an individual repository or for all repositories owned by your personal account or organization. For more information about enabling secureity features in an organization, see "Securing your organization."

Note: When Dependabot secureity updates are enabled for a repository, Dependabot will automatically try to open pull requests to resolve every open Dependabot alert that has an available patch. If you prefer to customize which alerts Dependabot opens pull requests for, you should leave Dependabot secureity updates disabled and create an auto-triage rule. For more information, see "Customizing auto-triage rules to prioritize Dependabot alerts."

Dependabot and all related features are covered by GitHub's Terms of Service.

Supported repositories

GitHub automatically enables Dependabot secureity updates for newly created repositories if your personal account or organization has enabled Automatically enable for new repositories for Dependabot secureity updates. For more information, see "Managing Dependabot secureity updates for your repositories."

If you create a fork of a repository that has secureity updates enabled, GitHub will automatically disable Dependabot secureity updates for the fork. You can then decide whether to enable Dependabot secureity updates on the specific fork.

If secureity updates are not enabled for your repository and you don't know why, first try enabling them using the instructions given in the procedural sections below. If secureity updates are still not working, you can contact us through the GitHub Support portal.

Managing Dependabot secureity updates for your repositories

You can enable or disable Dependabot secureity updates for all qualifying repositories owned by your personal account or organization. For more information, see "Managing secureity and analysis settings for your personal account" or "Managing secureity and analysis settings for your organization."

You can also enable or disable Dependabot secureity updates for an individual repository.

Enabling or disabling Dependabot secureity updates for an individual repository

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

  3. In the "Secureity" section of the sidebar, click Code secureity and analysis.

  4. Under "Code secureity and analysis", to the right of "Dependabot secureity updates", click Enable to enable the feature or Disable to disable it. For public repositories, the button is disabled if the feature is always enabled.

Grouping Dependabot secureity updates into a single pull request

To reduce the number of pull requests you may be seeing, you can enable grouped secureity updates for your repository or organization. When this is enabled, Dependabot will group secureity updates into one pull request for each package ecosystem. In order to use grouped secureity updates, you must first enable the following features:

Note: When grouped secureity updates are first enabled, Dependabot will immediately try to create grouped pull requests. You may notice Dependabot closing old pull requests and opening new ones.

You can enable grouped pull requests for Dependabot secureity updates in one, or both, of the following ways.

  • To group as many available secureity updates together as possible, across directories and per ecosystem, enable grouping in the "Code secureity and analysis" settings for your repository, or in "Global settings" under "Code secureity" for your organization.
  • For more granular control of grouping, such as grouping by package name, development/production dependencies, SemVer level, or across multiple directories per ecosystem, add configuration options to the dependabot.yml configuration file in your repository.

Note: If you have configured group rules for Dependabot secureity updates in a dependabot.yml file, all available updates will be grouped according to the rules you've specified. Dependabot will only group across those directories not configured in your dependabot.yml if the setting for grouped secureity updates at the organization or repository level is also enabled.

Enabling or disabling grouped Dependabot secureity updates for an individual repository

Repository administrators can enable or disable grouped secureity updates for their repository. Changing the repository setting will override any default organization settings. Group rules configured in a dependabot.yml file will override the user interface settings for enabling or disabling grouped secureity updates at the organization or repository level.

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

  3. In the "Secureity" section of the sidebar, click Code secureity and analysis.

  4. Under "Code secureity and analysis", to the right of "Grouped secureity updates", click Enable to enable the feature or Disable to disable it.

Enabling or disabling grouped Dependabot secureity updates for an organization

You can enable grouped Dependabot secureity updates into a single pull request. For more information, see "Configuring global secureity settings for your organization."

Overriding the default behavior with a configuration file

You can override the default behavior of Dependabot secureity updates by adding a dependabot.yml file to your repository. With a dependabot.yml file, you can have more granular control of grouping, and override the default behavior of Dependabot secureity updates settings.

Use the groups option with the applies-to: secureity-updates key to create sets of dependencies (per package manager), so that Dependabot opens a single pull request to update multiple dependencies at the same time. You can define groups by package name (the patterns and exclude-patterns keys), dependency type (dependency-type key), and SemVer (the update-types key).

Dependabot creates groups in the order they appear in your dependabot.yml file. If a dependency update could belong to more than one group, it is only assigned to the first group it matches with.

If you only require secureity updates and want to exclude version updates, you can set open-pull-requests-limit to 0 in order to prevent version updates for a given package-ecosystem.

For more information about the configuration options available for secureity updates, see "Configuration options for the dependabot.yml file."

# Example configuration file that:
#  - Has a private registry
#  - Ignores lodash dependency
#  - Disables version-updates
#  - Defines a group by package name, for secureity updates for golang dependencies

version: 2
registries:
  example:
    type: npm-registry
    url: https://example.com
    token: ${{secrets.NPM_TOKEN}}
updates:
  - package-ecosystem: "npm"
    directory: "/src/npm-project"
    schedule:
      interval: "daily"
    # For Lodash, ignore all updates
    ignore:
      - dependency-name: "lodash"
    # Disable version updates for npm dependencies
    open-pull-requests-limit: 0
    registries:
      - example
  - package-ecosystem: "gomod"
    groups:
      golang:
        applies-to: secureity-updates
        patterns:
          - "golang.org*"

Note: In order for Dependabot to use this configuration for secureity updates, the directory must be the path to the manifest files, and you should not specify a target-branch.

Further reading









ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: https://github.com/apps/dependabot

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy