Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[main] Servicing docs improvements #85855

Merged
merged 7 commits into from
May 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,4 @@ main PR <!-- Link to PR if any that fixed this in the main branch. -->

# Package authoring signed off?


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.
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.
4 changes: 3 additions & 1 deletion .github/workflows/check-service-labels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ jobs:
check-labels:
runs-on: ubuntu-latest
steps:
- name: Check servicing labels
- name: Check 'Servicing-approved' label
run: |
echo "Merging permission is enabled for servicing PRs when the `Servicing-approved` label is applied."
if [ "${{ contains(github.event.pull_request.labels.*.name, 'Servicing-approved') }}" = "true" ]; then
exit 0
else
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"
exit 1
fi
16 changes: 13 additions & 3 deletions docs/project/library-servicing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How to service a library

This document provides the steps necessary after modifying a library in a servicing branch.
This document provides the steps that need to be followed 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:

Expand Down Expand Up @@ -39,5 +39,15 @@ All the servicing change must go through an approval process. You have two ways
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.
- Bring it to the attention of the [engineering lead responsible for the area](~/docs/area-owners.md).
- If the fix is a product change, the area owner will:
- Add the `Servicing-consider` label.
- Ask the area owner to champion your PR in the .NET Tactics meeting to request merge approval.
- If the change is approved, they will replace the `Servicing-consider` label by `Servicing-approved` and sign-off the PR.
- If the fix is a test-only or infra-only change, the area owner will:
- Review the PR and sign-off if they approve it.
- Add the `Servicing-approved` label.

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).

**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.