Skip to content

Commit 531bf3c

Browse files
authored
Update backport template and servicing docs (#83795)
* Update backport template to indicate new staging branches rule. * Update library servicing.
1 parent 4e401d7 commit 531bf3c

File tree

2 files changed

+25
-3
lines changed

2 files changed

+25
-3
lines changed

.github/workflows/backport.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,9 @@ jobs:
2828
2929
## Risk
3030
31-
IMPORTANT: Is this backport for a servicing release? If so and this change touches code that ships in a NuGet package, please make certain that you have added any necessary [package authoring](https://github.com/dotnet/runtime/blob/main/docs/project/library-servicing.md) and gotten it explicitly reviewed.
31+
**IMPORTANT**: If this backport is for a servicing release, please verify that:
32+
33+
- The PR target branch is `release/X.0-staging`, not `release/X.0`.
34+
35+
- If the change touches code that ships in a NuGet package, you have added the necessary [package authoring](https://github.com/dotnet/runtime/blob/main/docs/project/library-servicing.md) and gotten it explicitly reviewed.
36+

docs/project/library-servicing.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# How to service a library
22

3-
This document provides the steps necessary after modifying a library in a servicing branch (where "servicing branch" refers to any branch whose name begins with `release/`).
3+
This document provides the steps necessary after modifying a library in a servicing branch.
4+
5+
Servicing branches represent shipped versions of .NET, and their name is in the format `release/X.0-staging`. Examples:
6+
7+
- `release/7.0-staging`
8+
- `release/6.0-staging`
49

510
## Check if a package is generated
611

@@ -23,4 +28,16 @@ All that's left is to ensure that your changes have worked as expected. To do so
2328

2429
## Approval Process
2530

26-
All the servicing change must go through an approval process. Please create your PR using [this template](https://raw.githubusercontent.com/dotnet/runtime/main/.github/PULL_REQUEST_TEMPLATE/servicing_pull_request_template.md). You should also add `servicing-consider` label to the pull request and bring it to the attention of the engineering lead responsible for the area.
31+
All the servicing change must go through an approval process. You have two ways to submit your PR:
32+
33+
- By manually creating your PR using [this template](https://raw.githubusercontent.com/dotnet/runtime/main/.github/PULL_REQUEST_TEMPLATE/servicing_pull_request_template.md).
34+
- Or by asking the bot to automatically create the servicing PR for you using a merged `main` PR as source. This method requires typing an AzDO backport command as a comment of your merged PR using the format `/backport to release/X.0-staging`. Examples:
35+
-
36+
- `/backport to release/7.0-staging`
37+
- `/backport to release/6.0-staging`
38+
39+
For both cases, you must:
40+
41+
- Fill out the template of the PR description.
42+
- Add the `servicing-consider` label.
43+
- Bring it to the attention of the engineering lead responsible for the area, so they consider the fix for servicing.

0 commit comments

Comments
 (0)