11---
2- title : Writing release-note pull requests
3- description : Turn a pull request into clear release notes that explain outcomes, adoption steps, and version impact .
2+ title : Formatting release-note pull requests
3+ description : Control the title, description, and label that automated releases reuse as user-facing release notes .
44---
55
6- # Writing release-note pull requests
6+ # Formatting release-note pull requests
77
8- For the default Process-PSModule configuration, a pull request title becomes the GitHub Release notes heading and its
9- description becomes the release notes body. The release name is the resolved version unless
10- ` Publish.Module.UsePRTitleAsReleaseName ` changes that setting. Treat the title, description, and selected version label
11- as the final decision about what users receive.
8+ This guide is the final content-control plan for an author formatting a pull request. It is not release notes for a
9+ specific change. It defines how the pull request title, description, and version label communicate what users receive
10+ when the automated release process reuses them.
1211
13- This guide extends the [ MSX PR format] ( https://msx.no/docs/Ways-of-Working/PR-Format/ ) with the release transition and
14- adoption information required by Process-PSModule consumers. It applies to any releasable artifact: a PowerShell
12+ With the default Process-PSModule settings, automation reuses the pull request title as the release notes heading and
13+ the description as the release notes body. The release name is the resolved version unless
14+ ` Publish.Module.UsePRTitleAsReleaseName ` changes that setting. The author, rather than the automation, makes the final
15+ message decision by formatting those three pull request fields before review.
16+
17+ This guide extends the [ MSX PR format] ( https://msx.no/docs/Ways-of-Working/PR-Format/ ) with the release transition
18+ and adoption information required by Process-PSModule consumers. It applies to any releasable artifact: a PowerShell
1519module, reusable workflow, GitHub Action, library, service, or infrastructure module.
1620
1721## Before starting
@@ -25,7 +29,7 @@ module, reusable workflow, GitHub Action, library, service, or infrastructure mo
2529
2630## Steps
2731
28- 1 . Write the title in the [ MSX PR format] ( https://msx.no/docs/Ways-of-Working/PR-Format/#title ) . Describe the
32+ 1 . Format the title in the [ MSX PR format] ( https://msx.no/docs/Ways-of-Working/PR-Format/#title ) . Describe the
2933 user-facing outcome, not the implementation activity.
30342 . Open with one concise paragraph that says what users receive and why it matters. Use present tense and active voice.
31353 . Group the changes by experience using ` ## New: ` , ` ## Changed: ` , ` ## Fixed: ` , and, for an incompatible release,
@@ -40,10 +44,11 @@ module, reusable workflow, GitHub Action, library, service, or infrastructure mo
4044 [ MSX PR format] ( https://msx.no/docs/Ways-of-Working/PR-Format/#description-structure ) . Technical details explain
4145 how the outcome was delivered; they do not replace the user-facing narrative or adoption steps.
4246
43- ## Release-note structure
47+ ## Pull-request description structure
4448
4549Use only the user-facing change headings that apply, but always include an adoption answer and release impact for a
46- published change.
50+ published change. This is the format of the pull-request description that the release process later reuses; it is not
51+ a separate release-note document to maintain.
4752
4853```` markdown
4954<One paragraph explaining what users receive and why it matters. >
@@ -119,19 +124,21 @@ Do not label this section `Migration` unless the release performs a genuine data
119124version update, reference change, configuration adjustment, or command replacement belongs under
120125` Adopting this release ` .
121126
122- ## Release impact
127+ ## Formatting release impact
123128
124129The configured version label determines the next version by applying its SemVer bump to the current published
125130version. The exact label can differ between repositories; describe its effect rather than relying on a conventional
126- name. The title and body explain the user value, while the version becomes the default GitHub Release name.
131+ name. The pull-request title and description explain the user value, while the version becomes the default GitHub
132+ Release name.
127133
128134Before marking a pull request ready, refresh the current version and planned version if another release landed while
129135the branch was open. Do not publish a stale numeric transition. A prerelease label selects a release channel alongside
130136the version bump; it is not the bump itself.
131137
132138## Verify
133139
134- - The title and opening paragraph are understandable without internal file, function, or class names.
140+ - The title, description, and selected label are understandable as one user-facing message without internal file,
141+ function, or class names.
135142- Every user-visible change says what the user gets, and the technical details remain in the final details block.
136143- ` Adopting this release ` gives complete, ordered instructions for affected users or explicitly says no action is
137144 needed.
0 commit comments