Skip to content

Commit 834cc1b

Browse files
am-steadgithub-actions
and
github-actions
authored
Dependabot Job Log List - [GA] github#11900 (#42407)
Co-authored-by: github-actions <[email protected]>
1 parent 7405c20 commit 834cc1b

File tree

8 files changed

+74
-6
lines changed

8 files changed

+74
-6
lines changed
Loading
Loading

content/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates.md

+14
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,19 @@ If any dependencies are missing, check the log files for errors. If any package
3737

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

40+
{% ifversion dependabot-job-log %}
41+
42+
{% data reusables.dependabot.dependabot-jobs-log-access %}
43+
44+
To view the full logs files for a particular job, to the right of the log entry you are interested in, click **view logs**.
45+
46+
![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)
47+
48+
For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/viewing-dependabot-job-logs)."
49+
50+
{% else %}
51+
4052
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.
4153
1. Optionally, to rerun the version check, click **Check for updates**.
54+
55+
{% endif %}

content/code-security/dependabot/working-with-dependabot/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ children:
2020
- /configuring-access-to-private-registries-for-dependabot
2121
- /guidance-for-the-configuration-of-private-registries-for-dependabot
2222
- /removing-dependabot-access-to-public-registries
23+
- /viewing-dependabot-job-logs
2324
- /troubleshooting-the-detection-of-vulnerable-dependencies
2425
- /troubleshooting-dependabot-errors
2526
---
26-

content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,24 @@ If an error blocked {% data variables.product.prodname_dependabot %} from creati
6060

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

63-
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.
63+
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 %}.
6464

65-
![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)
65+
{% ifversion dependabot-job-log %}
66+
67+
{% data reusables.dependabot.dependabot-jobs-log-access %}
68+
69+
To view the full logs files for a particular job, to the right of the log entry you are interested in, click **view logs**.
6670

67-
{% ifversion fpt or ghec %}
71+
![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)
6872

69-
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.
73+
For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/viewing-dependabot-job-logs)."
7074

7175
{% else %}
7276

77+
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.
78+
79+
![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)
80+
7381
To see the logs for any manifest file, click the **Last checked TIME ago** link, and then click **View logs**.
7482

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

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

180-
**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)."
188+
**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)."
181189

182190
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.
183191

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Viewing Dependabot job logs
3+
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.'
4+
shortTitle: Viewing Dependabot logs
5+
versions:
6+
feature: dependabot-job-log
7+
type: how_to
8+
topics:
9+
- Dependabot
10+
- Troubleshooting
11+
- Errors
12+
- Security updates
13+
- Dependencies
14+
---
15+
16+
## About {% data variables.product.prodname_dependabot %} job logs
17+
18+
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.
19+
20+
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.
21+
22+
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.
23+
24+
You will see the following job types recorded in the log list:
25+
- **Version update** - refers to a {% data variables.product.prodname_dependabot_version_updates %} run.
26+
- **Security update** - refers to a {% data variables.product.prodname_dependabot_security_updates %} run.
27+
- **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.
28+
29+
## Viewing {% data variables.product.prodname_dependabot %} job logs
30+
31+
The {% data variables.product.prodname_dependabot %} job logs list is accessible from the dependency graph tab in your repository.
32+
33+
{% data reusables.repositories.navigate-to-repo %}
34+
{% data reusables.repositories.accessing-repository-graphs %}
35+
{% data reusables.repositories.click-dependency-graph %}
36+
{% data reusables.dependabot.click-dependabot-tab %}
37+
1. To the right of the name of manifest file that you're interested in, click **Recent update jobs**.
38+
1. Optionally, to see the full logs files for a particular job, click **view logs**.
39+
40+
![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)

data/features/dependabot-job-log.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Reference: issue #11910
2+
versions:
3+
fpt: '*'
4+
ghec: '*'
5+
ghes: '>= 3.12'
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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 commit comments

Comments
 (0)