title | intro | shortTitle | redirect_from | versions | type | topics | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Troubleshooting Dependabot errors |
Sometimes {% data variables.product.prodname_dependabot %} is unable to raise a pull request to update your dependencies. You can review the error and unblock {% data variables.product.prodname_dependabot %}. |
Troubleshoot errors |
|
|
how_to |
|
{% data reusables.dependabot.enterprise-enable-dependabot %}
{% data reusables.dependabot.pull-request-introduction %}
If anything prevents {% data variables.product.prodname_dependabot %} from raising a pull request, this is reported as an error.
Note
{% data variables.product.prodname_dependabot %} doesn't create pull requests for inactive repositories. For information about inactivity criteria, see "AUTOTITLE" and "AUTOTITLE," for security and version updates, respectively.
{% ifversion dependabot-on-actions-opt-in %} For more information about troubleshooting when running {% data variables.product.prodname_dependabot %} on {% data variables.product.prodname_actions %} runners, see "AUTOTITLE." {% endif %}
When {% data variables.product.prodname_dependabot %} is blocked from creating a pull request to fix a {% data variables.product.prodname_dependabot %} alert, it posts the error message on the alert. The {% data variables.product.prodname_dependabot_alerts %} view shows a list of any alerts that have not been resolved yet. To access the alerts view, click {% data variables.product.prodname_dependabot_alerts %} on the Security tab for the repository. Where a pull request that will fix the vulnerable dependency has been generated, the alert includes a link to that pull request.
There are several reasons why an alert may have no pull request link:
- {% data variables.product.prodname_dependabot_security_updates %} are not enabled for the repository.
- The alert is for an indirect or transitive dependency that is not explicitly defined in a lock file.
- An error blocked {% data variables.product.prodname_dependabot %} from creating a pull request.
If an error blocked {% data variables.product.prodname_dependabot %} from creating a pull request, you can display details of the error by clicking the alert.
When {% data variables.product.prodname_dependabot %} is blocked from creating a pull request to update a dependency in an ecosystem, {% ifversion dependabot-job-log %} you can view the job logs list to find out more about the error {% else %} it posts the error icon on the manifest file{% endif %}.
{% ifversion dependabot-job-log %}
{% data reusables.dependabot.dependabot-jobs-log-access %}
To view the full logs files for a particular job, to the right of the log entry you are interested in, click view logs.
For more information, see "AUTOTITLE."
{% else %}
The manifest files that are managed by {% data variables.product.prodname_dependabot %} are listed on the {% data variables.product.prodname_dependabot %} tab. To access this tab, on the Insights tab for the repository click Dependency graph, and then click the {% data variables.product.prodname_dependabot %} tab.
To see the logs for any manifest file, click the Last checked TIME ago link, and then click View logs.
{% endif %}
Pull requests for security updates act to upgrade a vulnerable dependency to the minimum version that includes a fix for the vulnerability. In contrast, pull requests for version updates act to upgrade a dependency to the latest version allowed by the package manifest and {% data variables.product.prodname_dependabot %} configuration files. Consequently, some errors are specific to one type of update.
{% data variables.product.prodname_dependabot %} cannot update DEPENDENCY to a non-vulnerable version
Security updates only. {% data variables.product.prodname_dependabot %} cannot create a pull request to update the vulnerable dependency to a secure version without breaking other dependencies in the dependency graph for this repository.
Every application that has dependencies has a dependency graph, that is, a directed acyclic graph of every package version that the application directly or indirectly depends on. Every time a dependency is updated, this graph must resolve otherwise the application won't build. When an ecosystem has a deep and complex dependency graph, for example, npm and RubyGems, it is often impossible to upgrade a single dependency without upgrading the whole ecosystem.
The best way to avoid this problem is to stay up to date with the most recently released versions, for example, by enabling version updates. This increases the likelihood that a vulnerability in one dependency can be resolved by a simple upgrade that doesn't break the dependency graph. For more information, see "AUTOTITLE."
Security updates only. {% data variables.product.prodname_dependabot %} updates explicitly defined transitive dependencies that are vulnerable for all ecosystems. For npm, {% data variables.product.prodname_dependabot %} will raise a pull request that also updates the parent dependency if it's the only way to fix the transitive dependency.
For example, a project with a dependency on A
version ~2.0.0
which has a transitive dependency on B
version ~1.0.0
which has resolved to 1.0.1
.
my project
|
--> A (2.0.0) [~2.0.0]
|
--> B (1.0.1) [~1.0.0]
If a security vulnerability is released for B
versions <2.0.0
and a patch is available at 2.0.0
then {% data variables.product.prodname_dependabot %} will attempt to update B
but will find that it's not possible due to the restriction in place by A
which only allows lower vulnerable versions. To fix the vulnerability, {% data variables.product.prodname_dependabot %} will look for updates to dependency A
which allow the fixed version of B
to be used.
{% data variables.product.prodname_dependabot %} automatically generates a pull request that upgrades both the locked parent and child transitive dependencies.
{% data variables.product.prodname_dependabot %} fails to close a open pull request for an update that has already been applied on the default branch
{% data variables.product.prodname_dependabot %} will close pull requests for dependency updates, once it detects these updates have been committed to the default branch. However, in rare circumstances, the pull request may remain open. If you notice that you have committed an update to a dependency manually, and that the pull request for that same update is still open, you can use one of the following commands in a comment on the pull request:
@dependabot recreate
, or@dependabot rebase
.
Either comment will trigger {% data variables.product.prodname_dependabot %} to check if the dependency is no longer upgradable or vulnerable. If {% data variables.product.prodname_dependabot %} detects that the pull request is no longer required, it will close the pull request in this particular case.
For more information about {% data variables.product.prodname_dependabot %} comment commands, see "AUTOTITLE."
{% data variables.product.prodname_dependabot %} cannot update to the required version as there is already an open pull request for the latest version
Security updates only. {% data variables.product.prodname_dependabot %} will not create a pull request to update the vulnerable dependency to a secure version because there is already an open pull request to update this dependency. You will see this error when a vulnerability is detected in a single dependency and there's already an open pull request to update the dependency to the latest version.
There are two options: you can review the open pull request and merge it as soon as you are confident that the change is safe, or close that pull request and trigger a new security update pull request. For more information, see "Triggering a {% data variables.product.prodname_dependabot %} pull request manually."
Security updates only. {% data variables.product.prodname_dependabot %} cannot close a pull request to update a dependency that is not, or is no longer, vulnerable. You may see this error when dependency graph data is stale, or when the dependency graph and {% data variables.product.prodname_dependabot %} do not agree if a particular version of a dependency is vulnerable.
To debug the problem, we recommend you first examine the dependency graph for your repository, review what version it has detected for the dependency, and check if the identified version matches what is being used in your repository.
If you suspect your dependency graph data is out of date, you may need to manually update the dependency graph for your repository or investigate your dependency information further. For more information, see "AUTOTITLE."
If you are able to confirm the dependency version is no longer vulnerable, you can close the {% data variables.product.prodname_dependabot %} pull request.
{% data variables.product.prodname_dependabot %} took longer than the maximum time allowed to assess the update required and prepare a pull request. This error is usually seen only for large repositories with many manifest files, for example, npm or yarn monorepo projects with hundreds of package.json files. Updates to the Composer ecosystem also take longer to assess and may time out.
This error is difficult to address. If a version update times out, you could specify the most important dependencies to update using the allow
parameter or, alternatively, use the ignore
parameter to exclude some dependencies from updates. Updating your configuration might allow {% data variables.product.prodname_dependabot %} to review the version update and generate the pull request in the time available.
If a security update times out, you can reduce the chances of this happening by keeping the dependencies updated, for example, by enabling version updates. For more information, see "AUTOTITLE."
There's a limit on the number of open pull requests {% data variables.product.prodname_dependabot %} will generate. When this limit is reached, no new pull requests are opened and this error is reported. The best way to resolve this error is to review and merge some of the open pull requests.
There are separate limits for security and version update pull requests, so that open version update pull requests cannot block the creation of a security update pull request. The limit for security update pull requests is 10. By default, the limit for version updates is 5 but you can change this using the open-pull-requests-limit
parameter in the configuration file. For more information, see "AUTOTITLE."
The best way to resolve this error is to merge or close some of the existing pull requests and trigger a new pull request manually. For more information, see "Triggering a {% data variables.product.prodname_dependabot %} pull request manually."
If {% data variables.product.prodname_dependabot %} attempts to check whether dependency references need to be updated in a repository, but can't access one or more of the referenced files, the operation will fail with the error message "{% data variables.product.prodname_dependabot %} can't resolve your LANGUAGE dependency files." The API error type is git_dependencies_not_reachable
.
Similarly, if {% data variables.product.prodname_dependabot %} can't access a private package registry in which a dependency is located, one of the following errors is generated:
- "Dependabot can't reach a dependency in a private package registry"
(API error type:private_source_not_reachable
) - "Dependabot can't authenticate to a private package registry"
(API error type:private_source_authentication_failure
) - "Dependabot timed out while waiting for a private package registry"
(API error type:private_source_timed_out
) - "Dependabot couldn't validate the certificate for a private package registry"
(API error type:private_source_certificate_failure
)
To allow {% data variables.product.prodname_dependabot %} to update the dependency references successfully, make sure that all of the referenced dependencies are hosted at accessible locations.
Version updates only. {% data reusables.dependabot.private-dependencies-note %} Additionally, {% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. For more information, see "AUTOTITLE."
{% ifversion dependabot-version-updates-groups %}
{% data variables.product.prodname_dependabot %} fails to group a set of dependencies into a single pull request for {% data variables.product.prodname_dependabot_version_updates %}
{% ifversion dependabot-grouped-security-updates-config %}The groups
configuration settings in the dependabot.yml
file can apply to version updates and security updates. Use the applies-to
key to specify where (version updates or security updates) a set of grouping rules is applied.
{% data reusables.dependabot.dependabot-grouped-updates-applies-to %}{% else %}{% data reusables.dependabot.dependabot-version-updates-groups-supported %}{% endif %}
When you configure grouped version updates, you must configure groups per package ecosystem. To debug the problem, we recommend you look at the logs. For information about accessing the logs for a manifest, see "Investigating errors with {% data variables.product.prodname_dependabot_version_updates %}" above.
You may have unintentionally created empty groups. This happens, for example, when you set a dependency-type
in the allow
key for the overall job.
allow:
dependency-type: production
# this restricts the entire job to production dependencies
groups:
development-dependencies:
dependency-type: "development"
# this group will always be empty
In this example, {% data variables.product.prodname_dependabot %} will:
- Look at your dependency list and restrict the job to dependencies used in
production
only. - Try to create a group called
development-dependencies
which is a subset of this reduced list. - Work out that the
development-dependencies
group is empty as alldevelopment
dependencies were removed in step 1. - Individually update all the dependencies that are not in the group. As the group for dependencies in production is empty, {% data variables.product.prodname_dependabot %} will ignore the group, and create a separate pull request for each dependency.
You need to ensure that configuration settings don't cancel each other, and update them appropriately in your configuration file.
For more information on how to configure groups for {% data variables.product.prodname_dependabot_version_updates %}, see "AUTOTITLE."
{% ifversion dependabot-grouped-security-updates-config %}
{% data variables.product.prodname_dependabot %} fails to group a set of dependencies into a single pull request for {% data variables.product.prodname_dependabot_security_updates %}
The groups
configuration settings in the dependabot.yml
file can apply to version updates and security updates. Use the applies-to
key to specify where (version updates or security updates) a set of grouping rules is applied. Check you have grouping configured to apply to security updates. If the applies-to
key is absent from a set of grouping rules in your configuration, any group rules will by default only apply to version updates.
{% data reusables.dependabot.dependabot-grouped-updates-applies-to %}
For grouped security updates, {% data variables.product.prodname_dependabot %} uses the following guidelines to create grouped pull requests.
- {% data variables.product.prodname_dependabot %} will group dependencies from the same package ecosystem that are located in different directories when grouping rules are specified for configurations that use the
directories
key. - {% data variables.product.prodname_dependabot %} will apply other relevant customization options from the
dependabot.yml
file to pull requests for grouped security updates. {% data reusables.dependabot.dependabot-grouped-security-updates-yaml-override %} - {% data variables.product.prodname_dependabot %} will not group dependencies from different package ecosystems together.
- {% data variables.product.prodname_dependabot %} will not group security updates with version updates.
For more information, see "AUTOTITLE" and "AUTOTITLE."
{% endif %}
{% data variables.product.prodname_dependabot %} fails to update one of the dependencies in a grouped pull request
{% ifversion dependabot-grouped-security-updates-config %}There are different troubleshooting techniques you can use for failed version updates and failed security updates.
Version updates only. {% data variables.product.prodname_dependabot %} will show the failed update in your logs, as well as in the job summary at the end of your logs. You should use the @dependabot recreate
comment on the pull request to build the group again. For more information, see "AUTOTITLE."
If the dependency still fails to update, you should use the exclude-patterns
configuration so that the dependency is excluded from the group. {% data variables.product.prodname_dependabot %} will then raise a separate pull request to update the dependency.
If the dependency still fails to update, there may be a problem with the dependency itself, or with {% data variables.product.prodname_dependabot %} for that specific ecosystem.
{% data reusables.dependabot.dependabot-ignore-dependencies %}
{% ifversion dependabot-grouped-security-updates-config %}
Security updates only. If a grouped pull request for security updates fails or is unable to be merged, we recommend you manually open pull requests to bump the versions of breaking changes. When you manually update a package that is included in a grouped pull request, {% data variables.product.prodname_dependabot %} will rebase the pull request so it does not include the manually updated package.
{% data reusables.dependabot.dependabot-ignore-dependencies %}
{% endif %}
Version updates only. If the failure is due to a single dependency, you should use the exclude-patterns
configuration so that the dependency is excluded from the group. {% data variables.product.prodname_dependabot %} will then raise a separate pull request to update the dependency.
{% data reusables.dependabot.dependabot-ignore-dependencies %}
If you continue to see CI failures, you should remove the group configuration so that {% data variables.product.prodname_dependabot %} reverts to raising individual pull requests for each dependency. Then, you should check and confirm that the update works correctly for each individual pull request.
{% endif %}
If you unblock {% data variables.product.prodname_dependabot %}, you can manually trigger a fresh attempt to create a pull request.
- Security updates: Display the {% data variables.product.prodname_dependabot %} alert that shows the error you have fixed and click Create {% data variables.product.prodname_dependabot %} security update.
- Version updates: On the Insights tab for the repository click Dependency graph, and then click the Dependabot tab. Click Last checked TIME ago to see the log file that {% data variables.product.prodname_dependabot %} generated during the last check for version updates. Click Check for updates.