Skip to content

How to prepare a servicing PR

Jump to bottom
Artak edited this page Feb 10, 2024 · 7 revisions

When preparing a fix for a patch release, there are certain steps the engineers have to follow. This document details these steps and calls out ways to simplify the PR creation.

Preparing for a patch

  1. Work on a fix on a feature branch off of the release branch you're targeting your fix for. (i.e. for 5.0 that will be release/5.0).
  2. When the changes are ready, create the PR using the following template: https://aka.ms/aspnet/servicing/template

  • to simplify this step and avoid manual copy-pasting of the template, you can add the template=servicing.md query string parameter at the PR creation step as depicted here:

  • manually add the &template=servicing.md to the query string and you will see a view similar to the one below instead:

  • fill in all the required information in the template and create the PR

  1. As soon as the PR is created, it will automatically be added to the Servicing project board for visibility.
  2. Apply the Servicing-consider label as soon as the PR is ready for review by tactics.
  3. Wait for Tactics Approval. When the PR is approved by Tactics, the Servicing-consider label will be replaced by Servicing-approved. At this point the PR should be ready to merge as soon as the branches are open.
  4. Once the PR is merged, it should automatically get assigned to a milestone. Open all the linked issues that the PR was addressing and set the milestone of all the issues to the one the PR was set to. This is important, as usually the PRs in main are merged first, and the issues are being closed at that point, being (most of the time either leaves them in the generic servicing milestone (8.0.x) or in the current preview release.

Note, that it's your responsibility to get the PR merged in time. Consult with @dotnet/aspnet-build or your manager to learn the dates. As soon as branches are open, the PRs should be merged - no need to delay.

Clone this wiki locally