Update backport template and servicing docs (#83795)
authorCarlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
Tue, 28 Mar 2023 16:34:21 +0000 (09:34 -0700)
committerGitHub <noreply@github.com>
Tue, 28 Mar 2023 16:34:21 +0000 (10:34 -0600)
* Update backport template to indicate new staging branches rule.

* Update library servicing.

.github/workflows/backport.yml
docs/project/library-servicing.md

index d604ff4..3fca571 100644 (file)
@@ -28,4 +28,9 @@ jobs:
 
         ## Risk
 
-        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.
+        **IMPORTANT**: If this backport is for a servicing release, please verify that:
+
+        - The PR target branch is `release/X.0-staging`, not `release/X.0`.
+
+        - 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.
+
index ffdd1fc..aef1268 100644 (file)
@@ -1,6 +1,11 @@
 # How to service a library
 
-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/`).
+This document provides the steps necessary after modifying a library in a servicing branch.
+
+Servicing branches represent shipped versions of .NET, and their name is in the format `release/X.0-staging`. Examples:
+
+- `release/7.0-staging`
+- `release/6.0-staging`
 
 ## Check if a package is generated
 
@@ -23,4 +28,16 @@ All that's left is to ensure that your changes have worked as expected. To do so
 
 ## Approval Process
 
-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.
+All the servicing change must go through an approval process. You have two ways to submit your PR:
+
+- By manually creating your PR using [this template](https://raw.githubusercontent.com/dotnet/runtime/main/.github/PULL_REQUEST_TEMPLATE/servicing_pull_request_template.md).
+- 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:
+-
+  - `/backport to release/7.0-staging`
+  - `/backport to release/6.0-staging`
+
+For both cases, you must:
+
+- Fill out the template of the PR description.
+- Add the `servicing-consider` label.
+- Bring it to the attention of the engineering lead responsible for the area, so they consider the fix for servicing.