Skip to content

chore: prepare release notes and public API for v5.0.0#585

Merged
natemcmaster merged 1 commit intomainfrom
prepare-release-5.0
Jan 21, 2026
Merged

chore: prepare release notes and public API for v5.0.0#585
natemcmaster merged 1 commit intomainfrom
prepare-release-5.0

Conversation

@natemcmaster
Copy link
Owner

@natemcmaster natemcmaster commented Jan 21, 2026

Summary

  • Move new SourceGeneration APIs (165 entries) from PublicAPI.Unshipped.txt to PublicAPI.Shipped.txt
  • Update CHANGELOG.md header from "Unreleased changes" to "v5.0.0"
  • Add missing contributor references: @Chris-Wolfgang, @dependabot, @magneticflux-, @robertmclaws, @sensslen, @tlogik
  • Add 5.0 release notes to Hosting.CommandLine releasenotes.props

Test plan

  • Review CHANGELOG.md changes
  • Verify all new public APIs are moved to Shipped.txt
  • Verify Unshipped.txt is now empty (only contains #nullable enable)
  • Run ./build.ps1 to ensure no breaking changes

🤖 Generated with Claude Code

- Move new SourceGeneration APIs from Unshipped to Shipped
- Update CHANGELOG header from Unreleased to v5.0.0
- Add missing contributor references to CHANGELOG
- Add 5.0 release notes to Hosting.CommandLine

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@claude
Copy link

claude bot commented Jan 21, 2026

Code Review - PR #585

This PR correctly prepares the release notes and public API surface for v5.0.0. The changes are well-structured and follow the project's release management conventions.

Summary of Changes

1. CHANGELOG.md

2. PublicAPI.Shipped.txt

  • Moved 165 source generation API entries from Unshipped to Shipped
  • All entries are from the McMaster.Extensions.CommandLineUtils.SourceGeneration namespace
  • Entries cover the complete source generation system:
    • Metadata classes: ArgumentMetadata, CommandMetadata, OptionMetadata, etc.
    • Provider interfaces: ICommandMetadataProvider, IMetadataResolver
    • Handler interfaces: IExecuteHandler, IValidateHandler, IValidationErrorHandler
    • Factory interfaces: IModelFactory
    • Registry: CommandMetadataRegistry
    • Resolver: DefaultMetadataResolver

3. PublicAPI.Unshipped.txt

  • Confirmed empty (only contains #nullable enable)
  • All APIs correctly moved to Shipped

4. Hosting.CommandLine/releasenotes.props

  • Added v5.0.0 release notes with proper XML escaping (&lt; for <)
  • Documents breaking changes: dropped .NET Standard 2 and < .NET 6 support
  • Notes dependency updates to latest .NET 8 libraries
  • Proper version prefix condition check

Verification

All changes align with the release preparation requirements:

  • ✅ Public APIs properly transitioned from Unshipped to Shipped
  • ✅ CHANGELOG header updated to v5.0.0
  • ✅ All contributors properly credited
  • ✅ Release notes added for both packages
  • ✅ Conventional commit format used: chore: prepare release notes and public API for v5.0.0

Recommendation

LGTM - This PR is ready to merge. All changes are correct and follow the project conventions outlined in CLAUDE.md.

The only remaining validation is to run ./build.ps1 as noted in the test plan to ensure no breaking changes were introduced, but given the nature of these changes (documentation and API surface tracking only), no issues are expected.

@codecov
Copy link

codecov bot commented Jan 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.93%. Comparing base (190ac01) to head (713b42e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #585   +/-   ##
=======================================
  Coverage   79.93%   79.93%           
=======================================
  Files         120      120           
  Lines        4017     4017           
  Branches      872      872           
=======================================
  Hits         3211     3211           
  Misses        618      618           
  Partials      188      188           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@natemcmaster natemcmaster added this to the 5.0 milestone Jan 21, 2026
@natemcmaster natemcmaster merged commit 713b42e into main Jan 21, 2026
13 checks passed
@natemcmaster natemcmaster deleted the prepare-release-5.0 branch January 21, 2026 01:57
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.

1 participant