You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/managing-pull-requests-for-dependency-updates.md
+1-47Lines changed: 1 addition & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,18 +24,6 @@ contentType: how-tos
24
24
25
25
{% data reusables.dependabot.enterprise-enable-dependabot %}
26
26
27
-
## About {% data variables.product.prodname_dependabot %} pull requests
28
-
29
-
{% data reusables.dependabot.pull-request-introduction %}
30
-
31
-
When {% data variables.product.prodname_dependabot %} raises a pull request, you're notified by your chosen method for the repository. Each pull request contains detailed information about the proposed change, taken from the package manager. These pull requests follow the normal checks and tests defined in your repository.
32
-
{% ifversion fpt or ghec %}In addition, where enough information is available, you'll see a compatibility score. This may also help you decide whether or not to merge the change. For information about this score, see [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates).{% endif %}
33
-
34
-
If you have many dependencies to manage, you may want to customize the configuration for each package manager so that pull requests have specific assignees and labels. You may also want to group sets of dependencies together, so that multiple dependencies are updated in a single pull request. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-version-updates/customizing-dependabot-prs) and [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates#grouping-dependabot-updates-into-a-single-pull-request).
35
-
36
-
> [!NOTE]
37
-
> If you don't interact with {% data variables.product.prodname_dependabot %} pull requests for a repository during a 90-day time period, {% data variables.product.prodname_dependabot %} considers your repository as inactive, and will automatically pause {% data variables.product.prodname_dependabot_updates %}. For more information about inactivity criteria, see [AUTOTITLE](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates#about-automatic-deactivation-of-dependabot-updates) and [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-automatic-deactivation-of-dependabot-updates).
38
-
39
27
## Viewing {% data variables.product.prodname_dependabot %} pull requests
40
28
41
29
{% data reusables.repositories.navigate-to-repo %}
@@ -54,44 +42,10 @@ By default, {% data variables.product.prodname_dependabot %} will stop rebasing
54
42
55
43
## Managing {% data variables.product.prodname_dependabot %} pull requests with comment commands
56
44
57
-
{% data variables.product.prodname_dependabot %} responds to simple commands in comments. Each pull request contains details of the commands you can use to process the pull request (for example: to merge, squash, reopen, close, or rebase the pull request) under the "{% data variables.product.prodname_dependabot %} commands and options" section. The aim is to make it as easy as possible for you to triage these automatically generated pull requests.
58
-
59
-
You can use any of the following commands on a {% data variables.product.prodname_dependabot %} pull request.
60
-
61
-
| Command | Description |
62
-
| --- | --- |
63
-
|`@dependabot cancel merge`| Cancels a previously requested merge. |
64
-
|`@dependabot close`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from recreating that pull request. You can achieve the same result by closing the pull request manually. |
65
-
|`@dependabot ignore this dependency`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from creating any more pull requests for this dependency (unless you reopen the pull request or upgrade to the suggested version yourself). |
66
-
|`@dependabot ignore this major version`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from creating any more pull requests for this major version (unless you reopen the pull request or upgrade to this major version yourself). |
67
-
|`@dependabot ignore this minor version`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from creating any more pull requests for this minor version (unless you reopen the pull request or upgrade to this minor version yourself). |
68
-
|`@dependabot ignore this patch version`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from creating any more pull requests for this patch version (unless you reopen the pull request or upgrade to this patch version yourself). |
69
-
|`@dependabot merge`| Merges the pull request once your CI tests have passed. |
70
-
|`@dependabot rebase`| Rebases the pull request. |
71
-
|`@dependabot recreate`| Recreates the pull request, overwriting any edits that have been made to the pull request. |
72
-
|`@dependabot reopen`| Reopens the pull request if the pull request is closed. |
73
-
|`@dependabot show DEPENDENCY_NAME ignore conditions`| Retrieves information on the ignore conditions for the specified dependency, and comments on the pull request with a table that displays all ignore conditions for the dependency. For example, `@dependabot show express ignore conditions` would find all `ignore` conditions stored for the Express dependency, and comment on the pull request with that information. |
74
-
|`@dependabot squash and merge`| Squashes and merges the pull request once your CI tests have passed. |
45
+
You can use comment commands on {% data variables.product.prodname_dependabot %} pull requests to manage and customize your dependency updates. For details, see [AUTOTITLE](/code-security/reference/supply-chain-security/dependabot-pull-request-comment-commands).
75
46
76
47
{% data variables.product.prodname_dependabot %} will react with a "thumbs up" emoji to acknowledge the command, and may respond with a comment on the pull request. While {% data variables.product.prodname_dependabot %} usually responds quickly, some commands may take several minutes to complete if {% data variables.product.prodname_dependabot %} is busy processing other updates or commands.
77
48
78
49
If you run any of the commands for ignoring dependencies or versions, {% data variables.product.prodname_dependabot %} stores the preferences for the repository centrally. While this is a quick solution, for repositories with more than one contributor it is better to explicitly define the dependencies and versions to ignore in the configuration file. This makes it easy for all contributors to see why a particular dependency isn't being updated automatically.
79
50
80
51
For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#ignore--).
81
-
82
-
### Managing {% data variables.product.prodname_dependabot %} pull requests for grouped updates with comment commands
83
-
84
-
In {% data variables.product.prodname_dependabot %} pull requests for grouped version updates and security updates, you can use comment commands to ignore and un-ignore updates for specific dependencies and versions. You can use any of the following commands to manage ignore conditions for grouped updates.
85
-
86
-
| Command | Description |
87
-
| --- | --- |
88
-
|`@dependabot ignore DEPENDENCY_NAME`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from updating this dependency. |
89
-
|`@dependabot ignore DEPENDENCY_NAME major version`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from updating this dependency's major version. |
90
-
|`@dependabot ignore DEPENDENCY_NAME minor version`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from updating this dependency's minor version. |
91
-
|`@dependabot ignore DEPENDENCY_NAME patch version`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from updating this dependency's patch version. |
92
-
|`@dependabot unignore *`| Closes the current pull request, clears all `ignore` conditions stored for all dependencies in the group, then opens a new pull request. |
93
-
|`@dependabot unignore DEPENDENCY_NAME`| Closes the current pull request, clears all `ignore` conditions stored for the dependency, then opens a new pull request that includes available updates for the specified dependency. For example, `@dependabot unignore lodash` would open a new pull request that includes updates for the Lodash dependency. |
94
-
|`@dependabot unignore DEPENDENCY_NAME IGNORE_CONDITION`| Closes the current pull request, clears the stored `ignore` condition, then opens a new pull request that includes available updates for the specified ignore condition. For example, `@dependabot unignore express [< 1.9, > 1.8.0]` would open a new pull request that includes updates for Express between versions 1.8.0 and 1.9.0. |
95
-
96
-
> [!TIP]
97
-
> When you want to un-ignore a specific ignore condition, use the `@dependabot show DEPENDENCY_NAME ignore conditions` command to quickly check what ignore conditions a dependency currently has.
intro: '{% data variables.product.prodname_dependabot %} responds to commands in comments on its pull requests, making it easy to triage and manage dependency updates.'
4
+
allowTitleToDifferFromFilename: true
5
+
versions:
6
+
fpt: '*'
7
+
ghec: '*'
8
+
ghes: '*'
9
+
topics:
10
+
- Dependabot
11
+
- Version updates
12
+
- Repositories
13
+
- Dependencies
14
+
- Pull requests
15
+
shortTitle: Dependabot PR comment commands
16
+
contentType: reference
17
+
---
18
+
19
+
{% data variables.product.prodname_dependabot %} responds to simple commands in comments. Each pull request contains details of the commands you can use to process the pull request (for example: to merge, squash, reopen, close, or rebase the pull request) under the "{% data variables.product.prodname_dependabot %} commands and options" section. The aim is to make it as easy as possible for you to triage these automatically generated pull requests.
20
+
21
+
## Commands for {% data variables.product.prodname_dependabot %} pull requests
22
+
23
+
You can use any of the following commands on a {% data variables.product.prodname_dependabot %} pull request.
24
+
25
+
| Command | Description |
26
+
| --- | --- |
27
+
|`@dependabot cancel merge`| Cancels a previously requested merge. |
28
+
|`@dependabot close`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from recreating that pull request. You can achieve the same result by closing the pull request manually. |
29
+
|`@dependabot ignore this dependency`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from creating any more pull requests for this dependency (unless you reopen the pull request or upgrade to the suggested version yourself). |
30
+
|`@dependabot ignore this major version`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from creating any more pull requests for this major version (unless you reopen the pull request or upgrade to this major version yourself). |
31
+
|`@dependabot ignore this minor version`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from creating any more pull requests for this minor version (unless you reopen the pull request or upgrade to this minor version yourself). |
32
+
|`@dependabot ignore this patch version`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from creating any more pull requests for this patch version (unless you reopen the pull request or upgrade to this patch version yourself). |
33
+
|`@dependabot merge`| Merges the pull request once your CI tests have passed. |
34
+
|`@dependabot rebase`| Rebases the pull request. |
35
+
|`@dependabot recreate`| Recreates the pull request, overwriting any edits that have been made to the pull request. |
36
+
|`@dependabot reopen`| Reopens the pull request if the pull request is closed. |
37
+
|`@dependabot show DEPENDENCY_NAME ignore conditions`| Retrieves information on the ignore conditions for the specified dependency, and comments on the pull request with a table that displays all ignore conditions for the dependency. For example, `@dependabot show express ignore conditions` would find all `ignore` conditions stored for the Express dependency, and comment on the pull request with that information. |
38
+
|`@dependabot squash and merge`| Squashes and merges the pull request once your CI tests have passed. |
39
+
40
+
## Commands for grouped version updates
41
+
42
+
In {% data variables.product.prodname_dependabot %} pull requests for grouped version updates and security updates, you can use comment commands to ignore and un-ignore updates for specific dependencies and versions. You can use any of the following commands to manage ignore conditions for grouped updates.
43
+
44
+
| Command | Description |
45
+
| --- | --- |
46
+
|`@dependabot ignore DEPENDENCY_NAME`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from updating this dependency. |
47
+
|`@dependabot ignore DEPENDENCY_NAME major version`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from updating this dependency's major version. |
48
+
|`@dependabot ignore DEPENDENCY_NAME minor version`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from updating this dependency's minor version. |
49
+
|`@dependabot ignore DEPENDENCY_NAME patch version`| Closes the pull request and prevents {% data variables.product.prodname_dependabot %} from updating this dependency's patch version. |
50
+
|`@dependabot unignore *`| Closes the current pull request, clears all `ignore` conditions stored for all dependencies in the group, then opens a new pull request. |
51
+
|`@dependabot unignore DEPENDENCY_NAME`| Closes the current pull request, clears all `ignore` conditions stored for the dependency, then opens a new pull request that includes available updates for the specified dependency. For example, `@dependabot unignore lodash` would open a new pull request that includes updates for the Lodash dependency. |
52
+
|`@dependabot unignore DEPENDENCY_NAME IGNORE_CONDITION`| Closes the current pull request, clears the stored `ignore` condition, then opens a new pull request that includes available updates for the specified ignore condition. For example, `@dependabot unignore express [< 1.9, > 1.8.0]` would open a new pull request that includes updates for Express between versions 1.8.0 and 1.9.0. |
53
+
54
+
> [!TIP]
55
+
> When you want to un-ignore a specific ignore condition, use the `@dependabot show DEPENDENCY_NAME ignore conditions` command to quickly check what ignore conditions a dependency currently has.
0 commit comments