Skip to content

Commit 0139b48

Browse files
Changes for deprecation of dependabot-reviewers feature (#56781)
Co-authored-by: Anne-Marie <[email protected]>
1 parent 51c28fb commit 0139b48

File tree

5 files changed

+49
-86
lines changed

5 files changed

+49
-86
lines changed

content/code-security/dependabot/dependabot-security-updates/customizing-dependabot-security-prs.md

Lines changed: 12 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ For detailed guidance, see [Prioritizing meaningful updates](/code-security/depe
4242

4343
{% ifversion dependabot-reviewers-deprecation %}
4444

45+
## Automatically adding assignees
46+
47+
Use `assignees` to automatically add individuals or teams as assignees to pull requests.
48+
49+
For detailed guidance, see [Automatically adding assignees](/code-security/dependabot/dependabot-version-updates/customizing-dependabot-prs#automatically-adding-assignees).
50+
4551
## Automatically adding reviewers
4652

4753
To ensure your project's security updates get addressed promptly by the appropriate team, you can automatically add reviewers to Dependabot pull requests using a CODEOWNERS file. See [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
@@ -50,8 +56,10 @@ To ensure your project's security updates get addressed promptly by the appropri
5056

5157
## Automatically adding reviewers and assignees
5258

53-
> [!NOTE]
54-
> The `reviewers` property is closing down and will be removed in a future release of GitHub Enterprise Server.
59+
> [!IMPORTANT]
60+
> The `reviewers` property is closing down and will be removed in a future release of {% data variables.product.prodname_ghe_server %}.
61+
>
62+
> You can also automatically add reviewers and assignees using a CODEOWNERS file. See [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
5563
5664
To ensure your project's security updates get **addressed promptly** by the appropriate team, use `reviewers` and `assignees` to automatically add individuals or teams as **reviewers or assignees** to pull requests.
5765

@@ -91,62 +99,13 @@ In this example, the `dependabot.yml` file:
9199
* Is customized so that {% data variables.product.prodname_dependabot %} applies custom labels to the pull requests and automatically adds {% ifversion ghes < 3.19 %}reviewers and {% endif %}assignees.
92100
* Groups security updates for golang dependencies into a single pull request.
93101

94-
{% ifversion dependabot-reviewers-deprecation %}
95-
96-
```yaml copy
97-
# Example configuration file that:
98-
# - Uses a private registry for npm updates
99-
# - Ignores lodash dependency
100-
# - Disables version-updates
101-
# - Applies custom labels
102-
# - Group security updates for golang dependencies into a single pull request
103-
104-
version: 2
105-
registries:
106-
# Define a private npm registry with the name `example`
107-
example:
108-
type: npm-registry
109-
url: https://example.com
110-
token: {% raw %}${{secrets.NPM_TOKEN}}{% endraw %}
111-
updates:
112-
- package-ecosystem: "npm"
113-
directory: "/src/npm-project"
114-
schedule:
115-
interval: "daily"
116-
# For Lodash, ignore all updates
117-
ignore:
118-
- dependency-name: "lodash"
119-
# Disable version updates for npm dependencies
120-
open-pull-requests-limit: 0
121-
registries:
122-
# Ask Dependabot to use the private registry for npm
123-
- example
124-
# Raise all npm pull requests for security updates with custom labels
125-
labels:
126-
- "npm dependencies"
127-
- "triage-board"
128-
# Raise all npm pull requests for security updates with assignees
129-
assignees:
130-
- "user-name"
131-
- package-ecosystem: "gomod"
132-
groups:
133-
# Group security updates for golang dependencies
134-
# into a single pull request
135-
golang:
136-
applies-to: security-updates
137-
patterns:
138-
- "golang.org*"
139-
```
140-
141-
{% else %}
142-
143102
```yaml copy
144103
# Example configuration file that:
145104
# - Uses a private registry for npm updates
146105
# - Ignores lodash dependency
147106
# - Disables version-updates
148107
# - Applies custom labels
149-
# - Adds reviewers and assignees
108+
# - Adds assignees
150109
# - Group security updates for golang dependencies into a single pull request
151110

152111
version: 2
@@ -173,10 +132,6 @@ updates:
173132
labels:
174133
- "npm dependencies"
175134
- "triage-board"
176-
# Raise all npm pull requests for security updates with reviewers
177-
reviewers:
178-
- "my-org/team-name"
179-
- "octocat"
180135
# Raise all npm pull requests for security updates with assignees
181136
assignees:
182137
- "user-name"
@@ -190,12 +145,10 @@ updates:
190145
- "golang.org*"
191146
```
192147
193-
{% endif %}
194-
195148
## Example 2: configuration for version updates and security updates
196149
197150
In this example, the `dependabot.yml` file:
198-
* Is customized so that {% data variables.product.prodname_dependabot %} adds reviewers and custom labels to both version updates and security updates.
151+
* Is customized so that {% data variables.product.prodname_dependabot %} adds custom labels to both version updates and security updates.
199152
* Uses the `groups` customization option to create two groups ("`angular`" and "`production-dependencies`") in order to group multiple updates into single pull requests.
200153
* Specifies that the `groups` customization for `angular` applies to security updates only.
201154
* Specifies that the `groups` customization for `production-dependencies` applies to version updates only.
@@ -212,10 +165,6 @@ updates:
212165
labels:
213166
- "npm dependencies"
214167
- "triage-board"
215-
# Raise all npm pull requests for security and version updates with reviewers
216-
reviewers:
217-
- "my-org/team-name"
218-
- "octocat"
219168
groups:
220169
angular:
221170
# Group security updates for Angular dependencies into a single pull request

content/code-security/dependabot/dependabot-version-updates/customizing-dependabot-prs.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,37 +19,56 @@ shortTitle: Customize Dependabot PRs
1919

2020
There are various ways to customize your {% data variables.product.prodname_dependabot %} pull requests so that they better suit your own internal processes.
2121

22+
For example, to integrate {% data variables.product.prodname_dependabot %}'s pull requests into your CI/CD pipelines, it can apply **custom labels** to pull requests, which you can then use to trigger action workflows.
23+
24+
There are several different customization options which can all be used in combination, and tailored per package ecosystem.
25+
2226
{% ifversion dependabot-reviewers-deprecation %}
2327

24-
For example, to integrate {% data variables.product.prodname_dependabot %}'s pull requests into your CI/CD pipelines, it can apply **custom labels** to pull requests, which you can then use to trigger action workflows.
28+
## Automatically adding assignees
2529

26-
{% else %}
30+
By default, {% data variables.product.prodname_dependabot %} raises pull requests without any assignees.
2731

28-
For example:
29-
* To maximize efficiency, {% data variables.product.prodname_dependabot %} can automatically add specific individuals or teams as **reviewers** to its pull requests for a particular package ecosystem.
30-
* To integrate {% data variables.product.prodname_dependabot %}'s pull requests into your CI/CD pipelines, it can apply **custom labels** to pull requests, which you can then use to trigger action workflows.
32+
To automatically assign pull requests to a designated security team, you can use `assignees` to set these values per package ecosystem.
3133

32-
{% endif %}
34+
The example `dependabot.yml` file below changes the npm configuration so that all pull requests opened with version and security updates for npm have:
35+
* An individual ("`user-name`") automatically assigned to the pull requests.
3336

34-
There are several different customization options which can all be used in combination, and tailored per package ecosystem.
37+
```yaml copy
38+
# `dependabot.yml` file with
39+
# assignee for all npm pull requests
3540

36-
{% ifversion dependabot-reviewers-deprecation %}
41+
version: 2
42+
updates:
43+
# Keep npm dependencies up to date
44+
- package-ecosystem: "npm"
45+
directory: "/"
46+
schedule:
47+
interval: "weekly"
48+
# Raise all npm pull requests with assignees
49+
assignees:
50+
- "user-name"
51+
```
3752
3853
## Automatically adding reviewers
3954
40-
To ensure your project's security updates get addressed promptly by the appropriate team, you can automatically add reviewers to Dependabot pull requests using a CODEOWNERS file. See [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
55+
By default, {% data variables.product.prodname_dependabot %} raises pull requests without any reviewers.
56+
57+
To ensure your project's security updates get addressed promptly by the appropriate team, you can automatically add reviewers to {% data variables.product.prodname_dependabot %} pull requests using a CODEOWNERS file. See [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
4158
4259
{% else %}
4360
4461
## Automatically adding reviewers and assignees
4562
63+
> [!IMPORTANT]
64+
> The `reviewers` property is closing down and will be removed in a future release of {% data variables.product.prodname_ghe_server %}.
65+
>
66+
> You can also automatically add reviewers and assignees using a CODEOWNERS file. See [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
67+
4668
By default, {% data variables.product.prodname_dependabot %} raises pull requests without any reviewers or assignees.
4769

4870
However, you may want pull requests to be consistently reviewed or dealt with by a specific individual or team that has expertise in that package ecosystem, or automatically assigned to a designated security team. In which case, you can use `reviewers` and `assignees` to set these values per package ecosystem.
4971

50-
> [!NOTE]
51-
> The `reviewers` property is closing down and will be removed in a future release of GitHub Enterprise Server.
52-
5372
The example `dependabot.yml` file below changes the npm configuration so that all pull requests opened with version and security updates for npm have:
5473
* A team ("`my-org/team-name`") and an individual ("`octocat`") automatically added as reviewers to the pull requests.
5574
* An individual ("`user-name`") automatically assigned to the pull requests.
@@ -74,10 +93,6 @@ updates:
7493
- "user-name"
7594
```
7695
77-
{% data reusables.dependabot.option-affects-security-updates %}
78-
79-
See also [`assignees`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#assignees--) and [`reviewers`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#reviewers--).
80-
8196
{% endif %}
8297
8398
## Labeling pull requests with custom labels

content/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ redirect_from:
2727

2828
You can use {% data variables.product.prodname_actions %} to perform automated tasks when {% data variables.product.prodname_dependabot %} creates pull requests to update dependencies. You may find this useful if you want to:
2929

30-
* Ensure that {% data variables.product.prodname_dependabot %} pull requests (version updates and security updates) are created with the right data for your work processes, including labels, names, and reviewers.
30+
* Ensure that {% data variables.product.prodname_dependabot %} pull requests (version updates and security updates) are created with the right data for your work processes, including labels and names.
3131

3232
* Trigger workflows to send {% data variables.product.prodname_dependabot %} pull requests (version updates and security updates) into your review process or to merge automatically.
3333

content/code-security/dependabot/working-with-dependabot/dependabot-options-reference.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -574,8 +574,10 @@ Supported values: `REGISTRY_NAME` or `"*"`
574574

575575
## `reviewers` {% octicon "versions" aria-label="Version updates" height="24" %} {% octicon "shield-check" aria-label="Security updates" height="24" %}
576576

577-
> [!NOTE]
578-
> The `reviewers` property is closing down and will be removed in a future release of GitHub Enterprise Server.
577+
> [!IMPORTANT]
578+
> The `reviewers` property is closing down and will be removed in a future release of {% data variables.product.prodname_ghe_server %}.
579+
>
580+
> You can also automatically add reviewers and assignees using a CODEOWNERS file. See [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
579581

580582
Specify individual reviewers, or teams of reviewers, for all pull requests raised for a package manager. For examples, see [AUTOTITLE](/code-security/dependabot/dependabot-version-updates/customizing-dependabot-prs).
581583

@@ -590,9 +592,6 @@ When `reviewers` is defined:
590592

591593
Reviewers must have at least read access to the repository.
592594

593-
> [!NOTE]
594-
> You can also automatically add reviewers and assignees using a CODEOWNERS file. See [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
595-
596595
{% endif %}
597596

598597
## `schedule` {% octicon "versions" aria-label="Version updates only" height="24" %}

content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ shortTitle: Manage Dependabot PRs
3030
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.
3131
{% 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 %}
3232

33-
If you have many dependencies to manage, you may want to customize the configuration for each package manager so that pull requests have specific reviewers, 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).
33+
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).
3434

3535
> [!NOTE]
3636
> 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).

0 commit comments

Comments
 (0)