1
0
mirror of synced 2025-12-22 03:16:52 -05:00
Files
docs/content/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates.md
Jason Etcovitch caaee7a124 Update all files to use {% data %} (#15253)
* Add back changes from prior to purge

* Manually fix some invalid Liquid

* Updoot render-content

* Improve test messages to show correct output

* Run el scripto

* Pass the remaining test
2020-09-29 16:01:04 -04:00

8.5 KiB

title, intro, redirect_from, versions
title intro redirect_from versions
Configuring GitHub Dependabot security updates You can use {% data variables.product.prodname_dependabot_security_updates %} or manual pull requests to easily update vulnerable dependencies.
/articles/configuring-automated-security-fixes
/github/managing-security-vulnerabilities/configuring-automated-security-fixes
/github/managing-security-vulnerabilities/configuring-automated-security-updates
free-pro-team
*

About {% data variables.product.prodname_dependabot_security_updates %}

{% data variables.product.prodname_dependabot_short %} monitors security advisories such as the {% data variables.product.prodname_advisory_database %} and WhiteSource and automatically triggers a pull request when it detects a new vulnerable dependency in the dependency graph of repositories. For more information about the {% data variables.product.prodname_advisory_database %}, see "About the {% data variables.product.prodname_advisory_database %}."

{% data reusables.dependabot.upgrade-dependency-to-minimum-secure-version %}

{% data variables.product.prodname_dependabot_short %} includes a link to the pull request in the alert for the vulnerable dependency. For more information, see "About alerts for vulnerable dependencies" and "About the dependency graph."

Each security update contains everything you need to quickly and safely review and merge a proposed fix into your project. This includes information about the vulnerability like release notes, changelog entries, and commit details. Details of which vulnerability a pull request resolves are hidden from anyone who does not have access to {% data variables.product.prodname_dependabot_short %} alerts for the repository.

When you merge a pull request that contains a security update, the corresponding alert is marked as resolved for your repository.

{% note %}

Note {% data variables.product.prodname_dependabot_security_updates %} only resolve security vulnerabilities in the dependencies tracked by your dependency graph. Security updates are not created to resolve vulnerabilities in private registries or packages hosted in private repositories. However, indirect or transitive dependencies are included if they are explicitly defined in a lock file, or similar. For more information, see "About the dependency graph." Additionally, it's important to highlight that {% data variables.product.prodname_dependabot_security_updates %} automatically create pulls requests with proposed fixes to the lock files, for the dependencies detected as vulnerable.

{% endnote %}

You can enable {% data variables.product.prodname_dependabot_security_updates %} for any repository that uses {% data variables.product.prodname_dependabot_short %} alerts and the dependency graph. You can disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository or for all repositories owned by your user account or organization. For more information, see "Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories" below.

{% data reusables.dependabot.dependabot-tos %}

Supported repositories

{% data variables.product.prodname_dotcom %} automatically enables {% data variables.product.prodname_dependabot_security_updates %} for every repository that meets these prerequisites.

{% note %}

Note: You can manually enable {% data variables.product.prodname_dependabot_security_updates %}, even if the repository doesn't meet some of the prerequisites below. For example, you can enable {% data variables.product.prodname_dependabot_security_updates %} on a fork, or for a package manager that isn't directly supported by following the instructions in "Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories."

{% endnote %}

Automatic enablement prerequisite More information
Repository is not a fork "About forks"
Repository is not archived "Archiving repositories"
Repository is public, or repository is private and you have enabled read-only analysis by {% data variables.product.prodname_dotcom %}, dependency graph, and vulnerability alerts in the repository's settings "Managing data use settings for your private repository."
Repository contains dependency manifest file from a package ecosystem that {% data variables.product.prodname_dotcom %} supports "Supported package ecosystems"
{% data variables.product.prodname_dependabot_security_updates %} are not disabled for the repository "Managing {% data variables.product.prodname_dependabot_security_updates %} for your repository"
Repository is not already using an integration for dependency management "About integrations"

If security 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 security updates are still not working, you can contact support.

About compatibility scores

{% data variables.product.prodname_dependabot_security_updates %} also include compatibility scores to let you know whether updating a vulnerability could cause breaking changes to your project. We look at previously-passing CI tests from public repositories where we've generated a given security update to learn whether the update causes tests to fail. An update's compatibility score is the percentage of CI runs that passed when updating between relevant versions of the dependency.

Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories

You can enable or disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository.

You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories owned by your user account or organization. For more information, see "Managing security and analysis settings for your user account" or "Managing security and analysis settings for your organization."

{% data variables.product.prodname_dependabot_security_updates %} require specific repository settings. For more information, see "Supported repositories."

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %}

  1. Above the list of alerts, use the drop-down menu and select or unselect {% data variables.product.prodname_dependabot_short %} security updates. Drop-down menu with the option to enable {% data variables.product.prodname_dependabot_security_updates %}

Further reading