Skip to content

Commit 6bb00ea

Browse files
committed
docs: Update release notes for 5.0.1
1 parent 0431dff commit 6bb00ea

4 files changed

Lines changed: 49 additions & 10 deletions

File tree

.claude/skills/prepare-release/SKILL.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,20 @@ Run git commands to analyze commits since last release:
2323
- `git log --grep` for PR merges
2424
- Look for conventional commit patterns: `fix:`, `feat:`, `break:`, `docs:`, etc.
2525

26-
### 3. Categorize Changes
26+
### 3. Filter and Categorize Changes
2727

28-
Group into categories (in this order):
28+
**Exclude from release notes:**
29+
- Dependabot / automated dependency bump commits (e.g., `chore(deps): Bump ...`). These are routine maintenance and not user-facing.
30+
- CI/tooling-only changes (e.g., updating GitHub Actions workflows, claude workflows) unless they affect the shipped package.
31+
32+
Group remaining changes into categories (in this order):
2933

3034
1. **Breaking changes** (major versions only) - API removals, behavior changes
3135
2. **Features** - New functionality or APIs
3236
3. **Fixes** - Bug fixes and corrections
3337
4. **Improvements** - Performance or usability enhancements
3438
5. **Docs** - Documentation-only changes
35-
6. **Other** - Infrastructure, tooling, CI/CD
39+
6. **Other** - Infrastructure, tooling, CI/CD (only if user-facing or noteworthy)
3640

3741
### 4. Generate releasenotes.props Entry
3842

@@ -57,15 +61,31 @@ Fixes:
5761
```
5862

5963
**Patch versions:**
64+
65+
Append the patch notes directly at the end of the existing parent version's `StartsWith('X.Y.')` block. Do NOT create a separate conditional block. Add the patch section just before the closing `</PackageReleaseNotes>` tag of the parent version:
66+
6067
```xml
61-
<PackageReleaseNotes Condition="'$(VersionPrefix)' == 'X.Y.Z'">
62-
$(PackageReleaseNotes)
68+
<PackageReleaseNotes Condition="$(VersionPrefix.StartsWith('X.Y.'))">
69+
...existing X.Y.0 release notes...
6370

64-
X.Y.Z patch:
71+
Updates in X.Y.Z patch:
6572
* @user: fix description (#123)
6673
</PackageReleaseNotes>
6774
```
6875

76+
For multiple patches, append each one in order at the end of the same block:
77+
78+
```xml
79+
...existing X.Y.0 release notes...
80+
81+
Updates in X.Y.1 patch:
82+
* @user: fix description (#123)
83+
84+
Updates in X.Y.2 patch:
85+
* @user: another fix (#456)
86+
</PackageReleaseNotes>
87+
```
88+
6989
### 5. Generate CHANGELOG.md Entry
7090

7191
**Format:** `* [@contributor]: description ([#PR])`
@@ -196,10 +216,7 @@ See https://natemcmaster.github.io/CommandLineUtils/vX.0/upgrade-guide.html
196216

197217
### Patch Versions
198218

199-
Use `$(PackageReleaseNotes)` to inherit parent version's notes.
200-
201-
For first patch (X.Y.1), create new conditional entry after parent.
202-
For subsequent patches, add BEFORE existing patches but AFTER minor version.
219+
Append patch notes directly into the existing parent version's `StartsWith('X.Y.')` block in `releasenotes.props`. Do NOT create a separate conditional block or use `$(PackageReleaseNotes)` inheritance. Each patch gets an "Updates in X.Y.Z patch:" section appended at the end of the parent block.
203220

204221
## Quality Checklist
205222

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Changelog
22

3+
## [v5.0.1](https://github.com/natemcmaster/CommandLineUtils/compare/v5.0.0...v5.0.1)
4+
5+
### Features
6+
* [@sensslen]: Restore target framework compilation for .NET Framework ([#591])
7+
8+
[#591]: https://github.com/natemcmaster/CommandLineUtils/pull/591
9+
310
## [v5.0.0](https://github.com/natemcmaster/CommandLineUtils/compare/v4.1.1...v5.0.0)
411

512
### Breaking changes

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,3 +138,15 @@ If you need help with this project, please ...
138138

139139
This is a fork of [Microsoft.Extensions.CommandLineUtils](https://github.com/aspnet/Common), which was [completely abandoned by Microsoft](https://github.com/aspnet/Common/issues/257). This project [forked in 2017](https://github.com/natemcmaster/CommandLineUtils/commit/f039360e4e51bbf8b8eb6236894b626ec7944cec) and continued to make improvements. From 2017 to 2021, over 30 contributors added new features and fixed bugs. As of 2022, the project has entered maintenance mode, so no major changes are planned. [See this issue for details on latest project status.](https://github.com/natemcmaster/CommandLineUtils/issues/485) This project is not abandoned -- I believe this library provides a stable API and rich feature set good enough for most developers to create command line apps in .NET -- but only the most critical of bugs will be fixed (such as security issues).
140140
141+
## Supported .NET Versions
142+
143+
Framework | Version | Reason
144+
---------------|---------|--------------------
145+
`dotnet` | 8.0 | Lowest Microsoft LTS version at time of release. See <https://endoflife.date/dotnet>
146+
.NET Framework | 4.7.2 | Lowest .NET Framework version fully compatible with [.NET Standard 2.0][netstandard-guidance]
147+
148+
_Why not directly compile for .NET Standard?_
149+
150+
Microsoft guidance says ".NET 5 and later versions adopt a different approach to establishing uniformity that eliminates the need for .NET Standard in most scenarios." Compiling for 2 frameworks appears to be sufficient, so we avoid added complexity.
151+
152+
[netstandard-guidance]: https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0

src/CommandLineUtils/releasenotes.props

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ Other:
2626
* @natemcmaster: Use NuGet trusted publishing with OIDC
2727
* @dependabot: Update GitHub Actions (#568)
2828
* @natemcmaster: Upgrade docfx to 2.78.4
29+
30+
Updates in 5.0.1 patch:
31+
* @sensslen: Restore target framework compilation for .NET Framework (#591)
2932
</PackageReleaseNotes>
3033
<PackageReleaseNotes Condition="$(VersionPrefix.StartsWith('4.1.'))">
3134
Changes since 4.0:

0 commit comments

Comments
 (0)