Skip to content

Commit 9429621

Browse files
Marius StorhaugMarius Storhaug
authored andcommitted
Make release records the complete upgrade reference
1 parent 6a517c3 commit 9429621

5 files changed

Lines changed: 163 additions & 145 deletions

File tree

‎docs/content/guides/configuring-the-pipeline.md‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -142,27 +142,28 @@ Publish:
142142
UsePRTitleAsNotesHeading: true
143143
```
144144

145-
This produces release notes like:
145+
This produces release notes like this illustrative excerpt:
146146

147147
```markdown
148-
# 🚀 [Feature]: Commands can authenticate without browser callbacks (#42)
148+
# Commands identify missing required settings (#42)
149149
150-
Commands can now authenticate in environments where a browser callback is unavailable.
150+
Commands identify a missing required setting in the error message so users can correct the configuration directly.
151+
Accepted configuration and invocation stay unchanged.
151152
152-
## Adopting this release
153+
<!-- ANNOUNCEMENT STOP -->
153154
154-
1. Update the module to the released version.
155-
2. Replace interactive sign-in with the device-code command where browser callbacks are unavailable.
155+
## Fixed: Missing settings are easier to identify
156156
157-
## Release impact
158-
159-
- **Configured label:** `minor`
160-
- **SemVer change:** Minor.
161-
- **Version transition:** `v1.4.2` -> `v1.5.0`
157+
A missing required setting is named in the error instead of producing an unspecified configuration error. This affects
158+
users diagnosing invalid configuration. No configuration, code, or invocation change is required beyond selecting
159+
this release. Run the existing configuration check to verify that valid configuration still succeeds and an omitted
160+
required setting is named in the error.
162161
```
163162

164-
Use [Formatting release-note pull requests](formatting-release-note-prs.md) for the complete user-facing structure,
165-
including technical details and relevant issue links.
163+
Use [Formatting release-note pull requests](formatting-release-note-prs.md) for the complete structure, including
164+
result-scoped upgrade instructions and evidence. The author describes verified semantic impact and the applicable
165+
baseline; the publisher resolves the version. Keep complete transition instructions in the published body so PR and
166+
diff links remain optional depth.
166167

167168
### Version-only release names
168169

0 commit comments

Comments
 (0)