|
1 | 1 | <!-- |
2 | | -This is the final content-control plan for the pull request author. The automated release process reuses this title |
3 | | -and description as the GitHub Release notes by default; it does not create a separate release-note document. Format |
4 | | -the title, description, and selected version label for the people who use the released artifact. See |
5 | | -docs/content/guides/formatting-release-note-prs.md and the psmodule-release-note-authoring skill. Delete headings |
6 | | -that do not apply. Remove every placeholder and comment before marking the pull request ready. |
| 2 | +Follow docs/content/guides/formatting-release-note-prs.md and the shared MSX PR format. |
| 3 | +The release-bound title and complete description are the authored release record. Cover the entire delivered range, |
| 4 | +including prior merged or skipped deltas entering the artifact. Write an audience-first title without an icon/type prefix. |
| 5 | +Keep only applicable classifier sections in the order shown; repeat a section for each distinct result. |
| 6 | +Put complete upgrade instructions and necessary old-to-new examples in each result's prose. PRs/diffs are optional depth. |
| 7 | +Keep supporting blocks scoped to their result. For internal-only work without a classified result, place them after the marker. |
| 8 | +Remove placeholders, empty blocks, and authoring comments; keep the ANNOUNCEMENT STOP marker. |
7 | 9 | --> |
8 | 10 |
|
9 | | -<One concise paragraph: what users receive and why it matters.> |
| 11 | +{{ Concise summary: what changes, why, who is affected, and required action or an explicit no-action result. |
| 12 | +Lead with breaking impact when applicable. }} |
10 | 13 |
|
11 | | -## New: <capability> |
| 14 | +<!-- ANNOUNCEMENT STOP --> |
12 | 15 |
|
13 | | -<What users can now do and the result they get.> |
| 16 | +## Breaking: {{ Reader-facing result }} |
14 | 17 |
|
15 | | -## Changed: <behavior> |
| 18 | +{{ Explain the result, rationale, affected consumers, compatibility, and verified release/source baseline. |
| 19 | +Give exact adoption or migration actions, prerequisites, order, and verification. Include necessary old-to-new examples. |
| 20 | +Require intermediate installations or runs only when needed. State the no-action result for unaffected consumers. }} |
16 | 21 |
|
17 | | -<What users experience differently.> |
| 22 | +<details> |
| 23 | +<summary>Technical details</summary> |
| 24 | + |
| 25 | +{{ Implementation, validation commands and results, compatibility evidence, and standards alignment for this result. |
| 26 | +When an integration template applies, identify its repository and verified immutable compatible commit, |
| 27 | +producer-source compatibility evidence, and linked template work or a justified no-change result. }} |
18 | 28 |
|
19 | | -## Fixed: <problem> |
| 29 | +</details> |
20 | 30 |
|
21 | | -<What now works and how users benefit.> |
| 31 | +<details> |
| 32 | +<summary>Related references</summary> |
22 | 33 |
|
23 | | -## Breaking Changes |
| 34 | +- References Owner/Repository#123 |
24 | 35 |
|
25 | | -<What no longer works, who is affected, and the compatible replacement.> |
| 36 | +</details> |
26 | 37 |
|
27 | | -## Adopting this release |
| 38 | +## Removed: {{ Reader-facing result }} |
28 | 39 |
|
29 | | -1. <First action from the currently supported version, reference, configuration, or invocation.> |
30 | | -2. <Next action and how the user verifies the outcome.> |
| 40 | +{{ Explain what is removed and why, affected consumers, compatibility, and verified release/source baseline. |
| 41 | +Give the supported replacement, exact actions or explicit no-action result, prerequisites, order, and verification. |
| 42 | +Keep required transition examples here; require intermediate installations or runs only when needed. }} |
31 | 43 |
|
32 | | -<Or: No configuration, code, or invocation change is required. Update to this version normally.> |
| 44 | +<details> |
| 45 | +<summary>Technical details</summary> |
33 | 46 |
|
34 | | -## Release impact |
| 47 | +{{ Implementation, validation commands and results, compatibility and standards evidence for this result. |
| 48 | +Include applicable verified immutable template evidence and linked work or a justified no-change result. }} |
35 | 49 |
|
36 | | -- **Configured label:** `<label that selects this release>` |
37 | | -- **SemVer change:** `<Major | Minor | Patch>` |
38 | | -- **Version transition:** `<current published version> -> <planned release version>` |
39 | | -- **Release name:** `<planned release version>` |
| 50 | +</details> |
40 | 51 |
|
41 | | -<!-- |
42 | | -For a skip/no-release label, say that no artifact is published and no version transition occurs. |
43 | | -For a prerelease, state the selected bump and that it is not the latest stable version. |
44 | | ---> |
| 52 | +<details> |
| 53 | +<summary>Related references</summary> |
| 54 | + |
| 55 | +- References Owner/Repository#123 |
| 56 | + |
| 57 | +</details> |
| 58 | + |
| 59 | +## New: {{ Reader-facing result }} |
| 60 | + |
| 61 | +{{ Explain what consumers gain and why, applicability, compatibility, and verified release/source baseline. |
| 62 | +Distinguish optional feature use from required upgrade actions. Give exact actions or an explicit no-action result, |
| 63 | +prerequisites, order, verification, and any required intermediate installations or runs. }} |
| 64 | + |
| 65 | +<details> |
| 66 | +<summary>Technical details</summary> |
| 67 | + |
| 68 | +{{ Implementation, validation commands and results, compatibility and standards evidence for this result. |
| 69 | +Include applicable verified immutable template evidence and linked work or a justified no-change result. }} |
| 70 | + |
| 71 | +</details> |
| 72 | + |
| 73 | +<details> |
| 74 | +<summary>Related references</summary> |
| 75 | + |
| 76 | +- References Owner/Repository#123 |
| 77 | + |
| 78 | +</details> |
| 79 | + |
| 80 | +## Changed: {{ Reader-facing result }} |
| 81 | + |
| 82 | +{{ Explain what changes and why, affected consumers, compatibility, and verified release/source baseline. |
| 83 | +Give exact adoption or migration actions or an explicit no-action result, prerequisites, order, and verification. |
| 84 | +Keep required transition examples here; require intermediate installations or runs only when needed. }} |
| 85 | + |
| 86 | +<details> |
| 87 | +<summary>Technical details</summary> |
| 88 | + |
| 89 | +{{ Implementation, validation commands and results, compatibility and standards evidence for this result. |
| 90 | +Include applicable verified immutable template evidence and linked work or a justified no-change result. }} |
| 91 | + |
| 92 | +</details> |
| 93 | + |
| 94 | +<details> |
| 95 | +<summary>Related references</summary> |
| 96 | + |
| 97 | +- References Owner/Repository#123 |
| 98 | + |
| 99 | +</details> |
| 100 | + |
| 101 | +## Fixed: {{ Reader-facing result }} |
| 102 | + |
| 103 | +{{ Explain what works correctly and why it matters, affected consumers, compatibility, and verified release/source baseline. |
| 104 | +Give exact actions or an explicit no-action result, prerequisites, order, verification, and any required intermediate |
| 105 | +installations or runs. Keep necessary old-to-new examples in this prose. }} |
45 | 106 |
|
46 | | ---- |
47 | 107 | <details> |
48 | 108 | <summary>Technical details</summary> |
49 | 109 |
|
50 | | -<Implementation approach, compatibility evidence, validation, and standards alignment.> |
| 110 | +{{ Implementation, validation commands and results, compatibility and standards evidence for this result. |
| 111 | +Include applicable verified immutable template evidence and linked work or a justified no-change result. }} |
51 | 112 |
|
52 | 113 | </details> |
53 | 114 |
|
54 | 115 | <details> |
55 | | -<summary>Relevant issues (or links)</summary> |
| 116 | +<summary>Related references</summary> |
| 117 | + |
| 118 | +- References Owner/Repository#123 |
56 | 119 |
|
57 | | -- Resolves Owner/Repository#123 |
| 120 | +</details> |
58 | 121 |
|
59 | | -### Related work |
| 122 | +<!-- |
| 123 | +Keep Release decisions only when the target route invokes Release Management. |
| 124 | +Use the actual publisher's configured labels/defaults; this template does not migrate them. |
| 125 | +For no release, keep only Release and Labels, and state that no artifact or version is produced. |
| 126 | +The publisher resolves final numeric coordinates; do not predict them. |
| 127 | +--> |
| 128 | +<details> |
| 129 | +<summary>Release decisions</summary> |
60 | 130 |
|
61 | | -- References Owner/Repository#456 |
| 131 | +- **Release:** {{ Yes or No, with evidence from the artifact, target route, and supported consumer contracts. }} |
| 132 | +- **Version bump:** {{ Patch, Minor, or Major, with verified semantic impact and the configured decision source. Omit for No. }} |
| 133 | +- **Mode:** {{ Stable or Prerelease, with route or override evidence. Omit for No. }} |
| 134 | +- **Labels:** {{ Exact applied labels, or None when effective configuration supplies the decision without an override. }} |
62 | 135 |
|
63 | 136 | </details> |
0 commit comments