Skip to content

Commit edeee8e

Browse files
guntripCopilotN-Ushaerinhavdocs-bot
authored
GitHub Enterprise Server 3.19 RC (#58358)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Usha N <n-usha@github.com> Co-authored-by: Erin Havens <erinhav@github.com> Co-authored-by: docs-bot <77750099+docs-bot@users.noreply.github.com> Co-authored-by: Steve Ward <steveward@github.com>
1 parent 08f7ec6 commit edeee8e

File tree

45 files changed

+1114732
-65
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1114732
-65
lines changed

content/code-security/dependabot/working-with-dependabot/configuring-multi-ecosystem-updates.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ type: how_to
77
versions:
88
fpt: '*'
99
ghec: '*'
10+
ghes: '>=3.19'
1011
topics:
1112
- Dependabot
1213
- Version updates
@@ -18,7 +19,7 @@ shortTitle: Multi-ecosystem updates
1819

1920
## About multi-ecosystem updates
2021

21-
Multi-ecosystem updates allow you to create groups that span multiple package ecosystems and get a single {% data variables.product.prodname_dependabot %} pull request with updates across all supported ecosystems. This approach helps reduce the number of {% data variables.product.prodname_dependabot %} pull requests you receive and streamlines your dependency update workflow.
22+
Multi-ecosystem updates allow you to create groups that span multiple package ecosystems and get a single {% data variables.product.prodname_dependabot %} pull request with updates across all supported ecosystems. This approach helps reduce the number of {% data variables.product.prodname_dependabot %} pull requests you receive and streamlines your dependency update workflow.
2223

2324
Multi-ecosystem updates are particularly useful for:
2425

@@ -28,9 +29,9 @@ Multi-ecosystem updates are particularly useful for:
2829

2930
## Getting Started
3031

31-
You should follow these instructions to set up your first multi-ecosystem group.
32+
You should follow these instructions to set up your first multi-ecosystem group.
3233

33-
### 1. Add `multi-ecosystem-groups` to your `.github/dependabot.yml` file
34+
### 1. Add `multi-ecosystem-groups` to your `.github/dependabot.yml` file
3435

3536
Start by defining a group with a schedule in the top-level `multi-ecosystem-groups` section:
3637

@@ -46,7 +47,7 @@ updates:
4647
# Your existing package ecosystems will go here
4748
```
4849

49-
### 2. Assign ecosystems to groups with patterns
50+
### 2. Assign ecosystems to groups with patterns
5051

5152
1. Add the `multi-ecosystem-group` key.
5253
1. Add `patterns` to your package ecosystem configurations.
@@ -64,26 +65,26 @@ updates:
6465
directory: "/"
6566
patterns: ["nginx", "redis", "postgres"]
6667
multi-ecosystem-group: "infrastructure"
67-
68+
6869
- package-ecosystem: "terraform"
6970
directory: "/"
7071
patterns: ["aws", "terraform-*"]
7172
multi-ecosystem-group: "infrastructure"
7273
```
7374
7475
> [!IMPORTANT]
75-
> The `patterns` key is required when using `multi-ecosystem-group`. You can specify dependency patterns to include only certain dependencies in the group, or use `["*"]` to include all dependencies.
76+
> The `patterns` key is required when using `multi-ecosystem-group`. You can specify dependency patterns to include only certain dependencies in the group, or use `["*"]` to include all dependencies.
7677

77-
### 3. Commit and watch for consolidated pull requests
78+
### 3. Commit and watch for consolidated pull requests
7879

79-
Once you commit the changes to your `dependabot.yml` file, {% data variables.product.prodname_dependabot %} will:
80+
Once you commit the changes to your `dependabot.yml` file, {% data variables.product.prodname_dependabot %} will:
8081

8182
* Check for updates according to the group's schedule
8283
* Check for updates according to the group's schedule.
8384
* Create a single pull request containing updates for all the ecosystems specified in the group.
8485
* Use the group identifier in the branch name and the pull request title.
8586

86-
### 4. Customize with additional keys (optional)
87+
### 4. Customize with additional keys (optional)
8788

8889
Add [`assignees`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#assignees--), [`labels`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#labels--), and other settings to your groups:
8990

@@ -100,7 +101,7 @@ updates:
100101
directory: "/"
101102
patterns: ["nginx", "redis", "postgres"]
102103
multi-ecosystem-group: "infrastructure"
103-
104+
104105
- package-ecosystem: "terraform"
105106
directory: "/"
106107
patterns: ["aws", "terraform-*"]
@@ -111,8 +112,8 @@ updates:
111112

112113
Multi-ecosystem updates use a two-level configuration structure to provide flexibility and control over how updates are grouped and managed:
113114

114-
* **Group-level** (`multi-ecosystem-groups`): This is where you define the overall group behavior, scheduling, and shared settings that apply to all package ecosystems in the group.
115-
* **Ecosystem-level** (`updates`): Configure individual package managers within the group, including which dependencies to include and ecosystem-specific settings.
115+
* **Group-level** (`multi-ecosystem-groups`): This is where you define the overall group behavior, scheduling, and shared settings that apply to all package ecosystems in the group.
116+
* **Ecosystem-level** (`updates`): Configure individual package managers within the group, including which dependencies to include and ecosystem-specific settings.
116117

117118
This structure allows you to set consistent policies at the group level while maintaining fine-grained control over individual package ecosystems.
118119

@@ -151,7 +152,7 @@ The following table shows the configuration keys available at the group level, a
151152
| [`commit-message`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#commit-message--) |{% octicon "x" aria-label="Not required" %} |Group-only |
152153
| [`pull-request-branch-name`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#pull-request-branch-nameseparator--) |{% octicon "x" aria-label="Not required" %} |Group-only |
153154

154-
### Ecosystem-level (`updates`)
155+
### Ecosystem-level (`updates`)
155156

156157
The following table shows the configuration keys available at the ecosystem level, along with their behavior types. For more information, see [Configuration behavior](#configuration-behavior).
157158

@@ -262,9 +263,9 @@ updates:
262263
multi-ecosystem-group: "infrastructure"
263264
```
264265

265-
**Result**: One weekly pull request containing updates for Docker images, Terraform providers, and Python dependencies used in infrastructure automation.
266+
**Result**: One weekly pull request containing updates for Docker images, Terraform providers, and Python dependencies used in infrastructure automation.
266267

267-
### Full-stack applications
268+
### Full-stack applications
268269

269270
**Scenario**: You have a web application with a React frontend and Rails backend. You want frontend and backend dependencies updated together to ensure compatibility and streamline testing.
270271

@@ -289,7 +290,7 @@ updates:
289290

290291
**Result**: Daily PRs containing both frontend JavaScript/TypeScript updates and backend Ruby gem updates, allowing you to test the complete application together.
291292

292-
### Cross-platform libraries
293+
### Cross-platform libraries
293294

294295
**Scenario**: You're building a library or service that uses the same protocols across different languages (like gRPC and Protocol Buffers). You want to keep the library versions synchronized across all implementations.
295296

@@ -331,7 +332,7 @@ multi-ecosystem-groups:
331332
commit-message:
332333
prefix: "infra"
333334
include: "scope"
334-
335+
335336
# Application code updates - daily, with development team
336337
full-stack:
337338
schedule:
@@ -347,20 +348,20 @@ updates:
347348
assignees: ["@docker-admin"] # adds to @platform-team (additive)
348349
labels: ["docker"] # adds to infrastructure, dependencies (additive)
349350
multi-ecosystem-group: "infrastructure"
350-
351+
351352
# Terraform - infrastructure group with terraform specialists
352353
- package-ecosystem: "terraform"
353354
directory: "/"
354355
patterns: ["aws", "terraform-*"]
355356
multi-ecosystem-group: "infrastructure"
356-
357+
357358
# Frontend - full-stack group with frontend focus
358359
- package-ecosystem: "npm"
359360
directory: "/frontend"
360361
patterns: ["react", "lodash", "@types/*"]
361362
labels: ["frontend"] # adds to full-stack (additive)
362363
multi-ecosystem-group: "full-stack"
363-
364+
364365
# Backend - full-stack group with backend specialist
365366
- package-ecosystem: "bundler"
366367
directory: "/backend"
@@ -394,11 +395,11 @@ updates:
394395

395396
This approach ensures that the right people are involved for each type of update while maintaining consistent policies across related technologies.
396397

397-
## Best practices
398+
## Best practices
398399

399-
* **Group related dependencies**: Only group ecosystems that logically belong together.
400-
* **Use descriptive identifiers**: Choose group names that clearly indicate the group's purpose.
400+
* **Group related dependencies**: Only group ecosystems that logically belong together.
401+
* **Use descriptive identifiers**: Choose group names that clearly indicate the group's purpose.
401402

402-
### Further reading
403+
### Further reading
403404

404405
* [AUTOTITLE](/code-security/dependabot/working-with-dependabot/dependabot-options-reference)

content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/about-your-exposure-to-vulnerable-dependencies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ Focus on vulnerabilities that present the highest risk to your organization.
6565

6666
* Prioritize alerts with high or critical severity. For {% data variables.product.prodname_dependabot_alerts %}, also prioritize high EPSS scores, and available patches.
6767
* Use the repository breakdown information to direct remediation efforts to the most at-risk projects.{% ifversion fpt or ghec %}
68-
* Encourage development teams to address vulnerabilities that are actually used in deployed artifacts through repository custom properties and using production context. See [AUTOTITLE](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/alerts-in-production-code).{% endif %}
69-
* Create security campaigns to encourage and track the remediation of high priority {% data variables.product.prodname_code_scanning %} alerts. See [AUTOTITLE](/code-security/securing-your-organization/fixing-security-alerts-at-scale/creating-managing-security-campaigns).
68+
* Encourage development teams to address vulnerabilities that are actually used in deployed artifacts through repository custom properties and using production context. See [AUTOTITLE](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/alerts-in-production-code).{% endif %}{% ifversion security-campaigns %}
69+
* Create security campaigns to encourage and track the remediation of high priority {% data variables.product.prodname_code_scanning %} alerts. See [AUTOTITLE](/code-security/securing-your-organization/fixing-security-alerts-at-scale/creating-managing-security-campaigns).{% endif %}
7070

7171
### 4. Communicate risk and progress
7272

content/rest/code-scanning/alert-dismissal-requests.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
---
2-
title: REST API endpoints for {% data variables.product.prodname_code_scanning %} alert dismissal requests
2+
title: >-
3+
REST API endpoints for {% data variables.product.prodname_code_scanning %}
4+
alert dismissal requests
35
shortTitle: Alert dismissal requests
4-
intro: Use the REST API to interact with {% data variables.product.prodname_code_scanning %} alert dismissal requests from a repository.
6+
intro: >-
7+
Use the REST API to interact with {% data
8+
variables.product.prodname_code_scanning %} alert dismissal requests from a
9+
repository.
510
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
611
ghec: '*'
12+
ghes: '>=3.19'
713
topics:
814
- API
915
autogenerated: rest

content/rest/enterprise-admin/bypass-requests.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ shortTitle: Bypass requests
44
intro: Use the REST API to manage enterprise push rule bypass requests.
55
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
66
ghec: '*'
7+
ghes: '>=3.19'
78
topics:
89
- API
910
autogenerated: rest

content/rest/enterprise-admin/organization-installations.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
---
22
title: REST API for managing organization GitHub App installations
33
shortTitle: GitHub App installations
4-
intro: Use the REST API to manage which {% data variables.product.prodname_github_apps %} are installed in your enterprise's organizations.
4+
intro: >-
5+
Use the REST API to manage which {% data
6+
variables.product.prodname_github_apps %} are installed in your enterprise's
7+
organizations.
58
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
69
ghec: '*'
10+
ghes: '>=3.19'
711
topics:
812
- API
913
autogenerated: rest

content/rest/enterprise-admin/rules.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
---
22
title: REST API endpoints for rules
33
shortTitle: Rules
4-
intro: Use the REST API to manage rulesets for an enterprise. Rulesets control how people can interact with repositories and code.
4+
intro: >-
5+
Use the REST API to manage rulesets for an enterprise. Rulesets control how
6+
people can interact with repositories and code.
57
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
68
ghec: '*'
9+
ghes: '>=3.19'
710
topics:
811
- API
912
autogenerated: rest

content/rest/issues/issue-dependencies.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ intro: Use the REST API to view, add, and remove issue dependencies.
55
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
66
fpt: '*'
77
ghec: '*'
8+
ghes: '>=3.19'
89
topics:
910
- API
1011
autogenerated: rest

content/rest/projects/fields.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ intro: Use the REST API to manage Project fields
55
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
66
fpt: '*'
77
ghec: '*'
8+
ghes: '>=3.19'
89
topics:
910
- API
1011
autogenerated: rest

content/rest/projects/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@ children:
1212
versions:
1313
fpt: '*'
1414
ghec: '*'
15+
ghes: '>=3.19'
1516
---
1617

content/rest/projects/items.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ intro: Use the REST API to manage Project items
55
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
66
fpt: '*'
77
ghec: '*'
8+
ghes: '>=3.19'
89
topics:
910
- API
1011
autogenerated: rest

0 commit comments

Comments
 (0)