About Dependabot alerts
Dependabot alerts tell you that your code depends on a package that is insecure.
If your code depends on a package with a security vulnerability, this can cause a range of problems for your project or the people who use it. You should upgrade to a secure version of the package as soon as possible.
Detection of insecure dependencies
Note: Dependabot alerts is currently in beta and is subject to change.
Dependabot performs a scan of the default branch of your repository to detect insecure dependencies, and sends Dependabot alerts when:
-
New advisory data is synchronized to your enterprise each hour from GitHub.com. For more information, see "Browsing security advisories in the GitHub Advisory Database."
Note: Only advisories that have been reviewed by GitHub will trigger Dependabot alerts.
-
The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on. For more information, see "About the dependency graph."
Note: Dependabot doesn't scan archived repositories.
Additionally, GitHub can review any dependencies added, updated, or removed in a pull request made against the default branch of a repository, and flag any changes that would reduce the security of your project. This allows you to spot and deal with vulnerable dependencies before, rather than after, they reach your codebase. For more information, see "Reviewing dependency changes in a pull request."
As Dependabot alerts rely on the dependency graph, the ecosystems that are supported by Dependabot alerts are the same as those supported by the dependency graph. For a list of these ecosystems, see "About the dependency graph."
Note: It is important to keep your manifest and lock files up to date. If the dependency graph doesn't accurately reflect your current dependencies and versions, then you could miss alerts for insecure dependencies that you use. You may also get alerts for dependencies that you no longer use.
Configuration of Dependabot alerts
Enterprise owners must enable Dependabot alerts for your enterprise before you can use this feature. For more information, see "Enabling Dependabot for your enterprise."
When GitHub AE identifies a vulnerable dependency, we generate a Dependabot alert and display it in the repository's dependency graph. The alert includes information about a fixed version.
GitHub AE may also notify the maintainers of affected repositories about new alerts according to their notification preferences. For more information, see "Configuring notifications for Dependabot alerts."
Note: GitHub AE's security features do not claim to catch all vulnerabilities. We actively maintain GitHub Advisory Database and generate alerts with the most up-to-date information. However, we cannot catch everything or tell you about known vulnerabilities within a guaranteed time frame. These features are not substitutes for human review of each dependency for potential vulnerabilities or any other issues, and we recommend consulting with a security service or conducting a thorough dependency review when necessary.
Access to Dependabot alerts
You can see all of the alerts that affect a particular project in the repository's dependency graph. For more information, see "Viewing and updating Dependabot alerts."
By default, we notify people with admin permissions in the affected repositories about new Dependabot alerts.
You can choose the delivery method for notifications, as well as the frequency at which the notifications are sent to you. For more information, see "Configuring notifications for Dependabot alerts."
You can also see all the Dependabot alerts that correspond to a particular advisory in the GitHub Advisory Database. For more information, see "Browsing security advisories in the GitHub Advisory Database."