Skip to content

Commit

Permalink
Merge pull request github#28573 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Sep 28, 2023
2 parents 310c7e7 + 834cc1b commit a5612ba
Show file tree
Hide file tree
Showing 8 changed files with 74 additions and 6 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,19 @@ If any dependencies are missing, check the log files for errors. If any package

## Viewing {% data variables.product.prodname_dependabot %} log files

{% 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**.

![Screenshot of a Dependabot job log entry for the Gemfile package manager. A button, called "View logs", is highlighted in a dark orange outline.](/assets/images/help/dependabot/dependabot-job-logs.png)

For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/viewing-dependabot-job-logs)."

{% else %}

1. On the **{% data variables.product.prodname_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.
1. Optionally, to rerun the version check, click **Check for updates**.

{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ children:
- /configuring-access-to-private-registries-for-dependabot
- /guidance-for-the-configuration-of-private-registries-for-dependabot
- /removing-dependabot-access-to-public-registries
- /viewing-dependabot-job-logs
- /troubleshooting-the-detection-of-vulnerable-dependencies
- /troubleshooting-dependabot-errors
---

Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,24 @@ If an error blocked {% data variables.product.prodname_dependabot %} from creati

## Investigating errors with {% data variables.product.prodname_dependabot_version_updates %}

When {% data variables.product.prodname_dependabot %} is blocked from creating a pull request to update a dependency in an ecosystem, it posts the error icon on the manifest file. 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.
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 %}.

![Screenshot of the {% data variables.product.prodname_dependabot %} view. An alert icon, and a link, titled "Last checked 10 hours ago", is highlighted with an orange outline.](/assets/images/help/dependabot/dependabot-tab-view-error.png)
{% 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**.

{% ifversion fpt or ghec %}
![Screenshot of the Dependabot job log entries for a manifest file. A button, called "View logs", is highlighted in a dark orange outline.](/assets/images/help/dependabot/dependabot-job-log-error-message.png)

To see the log file for any manifest file, click the **Last checked TIME ago** link. When you display the log file for a manifest that's shown with an error symbol, any errors are also displayed.
For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/viewing-dependabot-job-logs)."

{% 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.

![Screenshot of the {% data variables.product.prodname_dependabot %} view. An alert icon, and a link, titled "Last checked 10 hours ago", is highlighted with an orange outline.](/assets/images/help/dependabot/dependabot-tab-view-error.png)

To see the logs for any manifest file, click the **Last checked TIME ago** link, and then click **View logs**.

{% endif %}
Expand Down Expand Up @@ -177,7 +185,7 @@ For more information on how to configure groups for {% data variables.product.pr

### {% data variables.product.prodname_dependabot %} fails to update one of the dependencies in a grouped pull request

**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](/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands)."
**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](/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands)."

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.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Viewing Dependabot job logs
intro: 'To support debugging of {% data variables.product.prodname_dependabot %} pull requests, {% data variables.product.product_name %} provides logs of all {% data variables.product.prodname_dependabot %} jobs.'
shortTitle: Viewing Dependabot logs
versions:
feature: dependabot-job-log
type: how_to
topics:
- Dependabot
- Troubleshooting
- Errors
- Security updates
- Dependencies
---

## About {% data variables.product.prodname_dependabot %} job logs

Whenever a {% data variables.product.prodname_dependabot %} job runs, the details of the job are captured in the job logs list, which is accessibile from the dependency graph.

For each manifest file, the job logs record the most recent runs of {% data variables.product.prodname_dependabot %}, with each log entry displaying the job type, job ID, timestamp, and, where necessary, a link to the pull request(s) associated with the job.

You may find that the log entry contains a short error message, which can be useful for debugging issues with a particular pull request or run. If you need to troubleshoot further, you can click **view logs** to access the full log files for a specific run.

You will see the following job types recorded in the log list:
- **Version update** - refers to a {% data variables.product.prodname_dependabot_version_updates %} run.
- **Security update** - refers to a {% data variables.product.prodname_dependabot_security_updates %} run.
- **Rebase update** - refers to a run where {% data variables.product.prodname_dependabot %} has automatically rebased the pull request to resolve a conflict with the target branch. This update could apply to a pull request from a {% data variables.product.prodname_dependabot_version_updates %} job, or a {% data variables.product.prodname_dependabot_security_updates %} job.

## Viewing {% data variables.product.prodname_dependabot %} job logs

The {% data variables.product.prodname_dependabot %} job logs list is accessible from the dependency graph tab in your repository.

{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.accessing-repository-graphs %}
{% data reusables.repositories.click-dependency-graph %}
{% data reusables.dependabot.click-dependabot-tab %}
1. To the right of the name of manifest file that you're interested in, click **Recent update jobs**.
1. Optionally, to see the full logs files for a particular job, click **view logs**.

![Screenshot of a Dependabot job log entry for the Gemfile package manager. A button, called "View logs", is highlighted in a dark orange outline.](/assets/images/help/dependabot/dependabot-job-logs.png)
5 changes: 5 additions & 0 deletions data/features/dependabot-job-log.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Reference: issue #11910
versions:
fpt: '*'
ghec: '*'
ghes: '>= 3.12'
1 change: 1 addition & 0 deletions data/reusables/dependabot/dependabot-jobs-log-access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The job logs list is accessible from the dependency graph of a repository. From the dependency graph, click the **{% data variables.product.prodname_dependabot %}** tab, then to the right of the affected manifest file, click **Recent update jobs**.

0 comments on commit a5612ba

Please sign in to comment.