Skip to content

[github]: Add backport test evidence sections - #350

Open
StormLiangMS wants to merge 1 commit into
sonic-net:masterfrom
StormLiangMS:docs-pr-template-backport-validation
Open

[github]: Add backport test evidence sections#350
StormLiangMS wants to merge 1 commit into
sonic-net:masterfrom
StormLiangMS:docs-pr-template-backport-validation

Conversation

@StormLiangMS

Copy link
Copy Markdown

Description of PR

Summary:
Aligns the sonic-linkmgrd PR template with the backport/cherry-pick validation
structure introduced in sonic-net/sonic-buildimage#28464 and
sonic-net/sonic-mgmt#26279. Adds a "Back port request" section (requiring a
linked GitHub issue or Microsoft ADO work item plus target-branch test
evidence for any backport/cherry-pick), a "Tested branch" section, and a
separate "Test result" section, using the same active release branch set
(202305, 202311, 202405, 202411, 202505, 202511, 202605). This is a
documentation/framework-only change to .github/pull_request_template.md;
no source, build, or automation code is touched.

Fixes # (issue)
N/A - documentation/framework change, not tied to a bug.

Type of change

  • Bug fix
  • New feature
  • Doc/Design
  • Unit test

Back port request

  • 202305
  • 202311
  • 202405
  • 202411
  • 202505
  • 202511
  • 202605

Tracking issue/work item for backport/cherry-pick request (GitHub issue or Microsoft ADO): N/A - no backport requested
Failure type: N/A

Tested branch

  • master
  • 202305
  • 202311
  • 202405
  • 202411
  • 202505
  • 202511
  • 202605
  • N/A

Test result

N/A - this PR only changes the Markdown PR template text/structure; there is
no image build or runtime test surface to validate. Validation performed was
template-only: rendered the Markdown to confirm section order, checkbox
syntax, and hidden-comment placement, and ran git diff --check to confirm
no whitespace errors.

Approach

What is the motivation for this PR?

sonic-buildimage and sonic-mgmt recently standardized their PR templates to
require an explicit tracking issue/work item and target-branch test evidence
before a backport/cherry-pick is honored. This PR brings sonic-linkmgrd's
template in line with that same structure so backport requests across the
three repos are validated consistently.

Work item tracking
  • Microsoft ADO (number only): N/A

How did you do it?

Inserted a new "Back port request" section immediately before "### Approach"
in .github/pull_request_template.md, with hidden Markdown comments
explaining that a backport/cherry-pick request requires a linked GitHub issue
or Microsoft ADO work item describing the failure, plus test evidence from
the target branch(es). Added unchecked checkboxes for the currently active
release branches (202305, 202311, 202405, 202411, 202505, 202511, 202605) and
visible "Tracking issue/work item" and "Failure type" fields. Added a
"### Tested branch" section (master + the same seven release branches + N/A)
and a separate "### Test result" section with examples for master and
202605. Updated the hidden comment under "How did you verify/test it?" to
point branch-specific evidence to the new Test result section, while
preserving the existing visible section. All other sections and wording were
preserved unchanged.

How did you verify/test it?

Rendered the updated template locally to confirm heading hierarchy, checkbox
list rendering, and hidden-comment (non-visible) placement match the
reference structure from sonic-buildimage#28464 / sonic-mgmt#26279. Ran
git diff --check against the change - no whitespace/trailing-space errors.
No backport of this change itself is requested (template-only, applies going
forward on master).

Any platform specific information?

N/A - this is a GitHub Markdown template file, not platform-specific code.

Documentation

This change is the documentation update (PR template itself). No
additional wiki updates are required.


Companion to sonic-net/sonic-buildimage#28464 and sonic-net/sonic-mgmt#26279.

Add a Back port request section before Approach, requiring a linked
GitHub issue or Microsoft ADO work item and target-branch test
evidence for any backport/cherry-pick request. Add release branch
checkboxes (202305, 202311, 202405, 202411, 202505, 202511, 202605),
a Tested branch section (master, the same release branches, and
N/A), and a separate Test result section for per-branch image
version and evidence. Point the existing How did you verify/test it?
note to the new Test result section for branch-specific evidence.

Companion to sonic-net/sonic-buildimage#28464 and
sonic-net/sonic-mgmt#26279.

Signed-off-by: Storm Liang <stormliang@microsoft.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@mssonicbld

Copy link
Copy Markdown
Collaborator

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

@StormLiangMS
StormLiangMS requested a review from yijingyan2 July 17, 2026 03:46
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants