Skip to content

Commit 5b71fde

Browse files
Servicing docs improvements (#85731)
Adding more details to our servicing documentation, particularly around the check-servicing-labels CI leg. Co-authored-by: Juan Hoyos <[email protected]>
1 parent c8ab0d3 commit 5b71fde

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

.github/PULL_REQUEST_TEMPLATE/servicing_pull_request_template.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,4 @@ main PR <!-- Link to PR if any that fixed this in the main branch. -->
2424

2525
# Package authoring signed off?
2626

27-
28-
IMPORTANT: If 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.
27+
IMPORTANT: If this change touches code that ships in a NuGet package, please make certain that you have added any necessary [package authoring](../../docs/project/library-servicing.md) and gotten it explicitly reviewed.

.github/workflows/check-service-labels.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,12 @@ jobs:
1313
check-labels:
1414
runs-on: ubuntu-latest
1515
steps:
16-
- name: Check servicing labels
16+
- name: Check 'Servicing-approved' label
1717
run: |
18+
echo "Merging permission is enabled for servicing PRs when the `Servicing-approved` label is applied."
1819
if [ "${{ contains(github.event.pull_request.labels.*.name, 'Servicing-approved') }}" = "true" ]; then
1920
exit 0
2021
else
22+
echo "::error:: 'Servicing-approved' label not applied to the PR yet. More information: https://github.com/dotnet/runtime/blob/main/docs/project/library-servicing.md#approval-process"
2123
exit 1
2224
fi

docs/project/library-servicing.md

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

3-
This document provides the steps necessary after modifying a library in a servicing branch.
3+
This document provides the steps that need to be followed after modifying a library in a servicing branch.
44

55
Servicing branches represent shipped versions of .NET, and their name is in the format `release/X.0-staging`. Examples:
66

@@ -41,5 +41,15 @@ All the servicing change must go through an approval process. You have two ways
4141
For both cases, you must:
4242

4343
- Fill out the template of the PR description.
44-
- Add the `servicing-consider` label.
45-
- Bring it to the attention of the engineering lead responsible for the area, so they consider the fix for servicing.
44+
- Bring it to the attention of the [engineering lead responsible for the area](~/docs/area-owners.md).
45+
- If the fix is a product change, the area owner will:
46+
- Add the `Servicing-consider` label.
47+
- Ask the area owner to champion your PR in the .NET Tactics meeting to request merge approval.
48+
- If the change is approved, they will replace the `Servicing-consider` label by `Servicing-approved` and sign-off the PR.
49+
- If the fix is a test-only or infra-only change, the area owner will:
50+
- Review the PR and sign-off if they approve it.
51+
- Add the `Servicing-approved` label.
52+
53+
The area owner can then merge the PR once the CI looks good (it's either green or the failures are investigated and determined to be unrelated to the PR).
54+
55+
**Note**: Applying the `Servicing-approved` label ensures the `check-service-labels` CI job passes, which is a mandatory requirement for merging a PR in a servicing branch.

0 commit comments

Comments
 (0)