Add backport email template #124085
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Backport Email Template | ||
|
|
||
| Use this template when emailing Tactics to request approval for a backport to a release branch. | ||
|
Member
There was a problem hiding this comment. This may want to explicitly say to include a verbatim text from the PR description in the email. I do not think we want the PR description and the description in the email to be different.
Member
Author
There was a problem hiding this comment. The intended flow I had in mind is definitely that way. The backport PR is the basis for any email we send out. I'll see if we can enforce (or nudge) that flow through the template. |
||
|
|
||
| > **Important:** The email content should come directly from your backport PR description | ||
| > (see `servicing_pull_request_template.md`). Do not write different text for the email — | ||
| > copy the sections verbatim from the PR to ensure consistency. | ||
|
|
||
| > **Note:** Most email clients (Outlook, Gmail, etc.) don't render Markdown. The section | ||
| > headers use `**bold**` syntax which appears with asterisks in plain-text emails. | ||
|
|
||
| --- | ||
|
|
||
| **Subject:** [release/X.0] Backport request: <BRIEF_DESCRIPTION> (#<PR_NUMBER>) | ||
|
|
||
| --- | ||
|
|
||
| Hello Tactics, | ||
|
Member
There was a problem hiding this comment. This does not belong into the PR description
Member
Author
There was a problem hiding this comment. Do you sleep ;-)? I changed it to compliment the existing template. Will help with email generation.
Member
There was a problem hiding this comment. I understand you want this in the email, but I do not think we want this in the commit history.
Member
Author
There was a problem hiding this comment. ok, I'm sure there will be another way to have templates outside the repo to achieve the same result.
Member
There was a problem hiding this comment. I have missed that this is meant to be an email template only. The filename made it look like one of the those templates that are picked up by github workflows automatically. It is fine to have the automation for this checked in. Should it be under skills directory?
Member
Author
There was a problem hiding this comment. I don't think it needs a skill. I think it's similar to the other templates and it can just find it accordingly. Allows you to say something like "I want to create an email to tactics for PR ". I'll open this back up shortly. |
||
|
|
||
| Please consider https://github.com/dotnet/runtime/pull/<PR_NUMBER> for backporting into release/X.0. | ||
|
|
||
| Fixes https://github.com/dotnet/runtime/issues/<ISSUE_NUMBER> | ||
|
|
||
| main PR: <MAIN_PR_LINK> | ||
|
|
||
| <!-- Copy the following sections verbatim from your backport PR description --> | ||
|
Member
There was a problem hiding this comment. Can this just say "Copy the PR description verbatim" and drop the rest that is duplicating the PR template content? |
||
|
|
||
| **DESCRIPTION** | ||
|
|
||
| <Copy from PR: Description section> | ||
|
|
||
| **CUSTOMER IMPACT** | ||
|
|
||
| - [ ] Customer reported | ||
| - [ ] Found internally | ||
|
Comment on lines
+34
to
+35
There was a problem hiding this comment. The checkbox syntax |
||
|
|
||
| <Copy from PR: Customer Impact section> | ||
|
|
||
| **REGRESSION** | ||
|
|
||
| - [ ] Yes | ||
| - [ ] No | ||
|
|
||
| <Copy from PR: Regression section> | ||
|
|
||
| **TESTING** | ||
|
|
||
| <Copy from PR: Testing section> | ||
|
|
||
| **RISK** | ||
|
|
||
| <Copy from PR: Risk section> | ||
|
Comment on lines
+50
to
+52
There was a problem hiding this comment. PR description says the email template includes a Risk High/Medium/Low selection with justification, but the template only has a free-form |
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,81 @@ | ||||||
| --- | ||||||
| name: backport-email | ||||||
| description: Generate a backport email from a PR for sending to Tactics. Use when asked to create or generate a backport email. | ||||||
| --- | ||||||
|
|
||||||
| # Backport Email Generation | ||||||
|
|
||||||
| Generate a formatted email for requesting backport approval from Tactics. | ||||||
|
|
||||||
| ## Required Input | ||||||
|
|
||||||
| Ask the user for the **backport PR URL** if not provided. Example: | ||||||
| - `https://github.com/dotnet/runtime/pull/124058` | ||||||
|
|
||||||
| ## Process | ||||||
|
|
||||||
| 1. **Fetch the backport PR** using the GitHub MCP tools to get: | ||||||
| - PR number and title | ||||||
| - Target release branch (e.g., `release/9.0`) | ||||||
| - PR description containing the servicing template sections | ||||||
|
|
||||||
| 2. **Extract from the PR description:** | ||||||
| - Link to the original main PR | ||||||
| - Link to the issue being fixed | ||||||
| - DESCRIPTION section | ||||||
| - CUSTOMER IMPACT section (including checkboxes) | ||||||
| - REGRESSION section (including checkboxes) | ||||||
| - TESTING section | ||||||
| - RISK section | ||||||
|
Comment on lines
+22
to
+29
There was a problem hiding this comment. This skill says the PR description contains checkbox blocks for Customer Impact/Regression and instructs to preserve |
||||||
|
|
||||||
| 3. **Generate the email** following the template at `.github/BACKPORT_EMAIL_TEMPLATE.md` | ||||||
|
|
||||||
| ## Output Format | ||||||
|
|
||||||
| Output the email as **plain text** (not markdown) since email clients don't render markdown. | ||||||
|
|
||||||
| ``` | ||||||
| Subject: [release/X.0] Backport request: <TITLE> (#<PR_NUMBER>) | ||||||
|
There was a problem hiding this comment. The sample subject line here uses
Suggested change
|
||||||
|
|
||||||
| Hello Tactics, | ||||||
|
|
||||||
| Please consider https://github.com/dotnet/runtime/pull/<PR_NUMBER> for backporting into release/X.0. | ||||||
|
|
||||||
| Fixes https://github.com/dotnet/runtime/issues/<ISSUE_NUMBER> | ||||||
|
|
||||||
| main PR: <MAIN_PR_LINK> | ||||||
|
|
||||||
| **DESCRIPTION** | ||||||
|
|
||||||
| <description text> | ||||||
|
|
||||||
| **CUSTOMER IMPACT** | ||||||
|
|
||||||
| - [ ] Customer reported | ||||||
| - [ ] Found internally | ||||||
|
|
||||||
| <customer impact text> | ||||||
|
|
||||||
| **REGRESSION** | ||||||
|
|
||||||
| - [ ] Yes | ||||||
| - [ ] No | ||||||
|
|
||||||
| <regression text> | ||||||
|
|
||||||
| **TESTING** | ||||||
|
|
||||||
| <testing text> | ||||||
|
|
||||||
| **RISK** | ||||||
|
|
||||||
| <risk text> | ||||||
| ``` | ||||||
|
|
||||||
| ## Important Notes | ||||||
|
|
||||||
| - **Do NOT attempt to open the email in Outlook or any email client.** Just output the formatted text for the user to copy. | ||||||
| - Preserve the `**bold**` section headers as they appear reasonably well in plain-text emails. | ||||||
| - Preserve the checkbox format `- [ ]` or `- [x]` from the PR description. | ||||||
| - Extract the release branch version (e.g., `9.0`) from the PR's base branch. | ||||||
| - If any section is missing from the PR description, note it and leave a placeholder. | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How much does the file name matter for copilot? Can the file be in a subdirectory and have a name that does not look like a special name recognized by github? (For example, the existing
PULL_REQUEST_TEMPLATEis a special directory name that github knowns about.)