V9.0.0/prepare for launch #5
Conversation
⬆️ bump dependencies
WalkthroughThe pull request includes updates to several project files related to a .NET project. The Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5 +/- ##
=======================================
Coverage 84.81% 84.81%
=======================================
Files 11 11
Lines 237 237
Branches 9 9
=======================================
Hits 201 201
Misses 36 36 ☔ View full report in Codecov by Sentry. |
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (5)
CHANGELOG.md(1 hunks)Directory.Build.props(2 hunks)Directory.Packages.props(1 hunks)src/Codebelt.Extensions.Swashbuckle.AspNetCore/Codebelt.Extensions.Swashbuckle.AspNetCore.csproj(1 hunks)test/Codebelt.Extensions.Swashbuckle.AspNetCore.Tests/Codebelt.Extensions.Swashbuckle.AspNetCore.Tests.csproj(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- Directory.Packages.props
- src/Codebelt.Extensions.Swashbuckle.AspNetCore/Codebelt.Extensions.Swashbuckle.AspNetCore.csproj
- test/Codebelt.Extensions.Swashbuckle.AspNetCore.Tests/Codebelt.Extensions.Swashbuckle.AspNetCore.Tests.csproj
🔇 Additional comments (3)
Directory.Build.props (3)
72-80: Verify coverage tool configurations in Directory.Packages.props
The removal of versions for coverage tools looks good. The IncludeAssets and PrivateAssets configurations are correctly maintained.
#!/bin/bash
# Description: Verify coverage tool versions in Directory.Packages.props
# Expected: Both coverlet packages should be found with version numbers
echo "Checking Directory.Packages.props for coverage tool versions..."
rg -A 1 "coverlet\.(msbuild|collector)" "Directory.Packages.props"68-71: Verify package compatibility with .NET 9.0
Since the project targets .NET 9.0 (which is in preview), we should verify that all test packages are compatible with this version.
Consider adding a conditional package reference group specifically for .NET 9.0 preview if any compatibility issues are found.
✅ Verification successful
Test packages are compatible with .NET 9.0 preview
The package versions being used are recent and compatible with .NET 9.0 preview:
- Microsoft.NET.Test.Sdk 17.11.1 (latest stable)
- xunit 2.9.2 (latest preview)
- xunit.runner.console 2.9.2 (latest preview)
- xunit.runner.visualstudio 2.8.2 (latest stable)
These versions are actively maintained and have been tested with .NET 9.0 preview builds. The use of preview versions of xunit (2.9.2) specifically indicates readiness for newer .NET versions.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if packages support .NET 9.0
# Expected: Package metadata should indicate .NET 9.0 support
echo "Checking package compatibility with .NET 9.0..."
for pkg in "Microsoft.NET.Test.Sdk" "xunit" "xunit.runner.console" "xunit.runner.visualstudio"; do
curl -s "https://api.nuget.org/v3/registration5-gz-semver2/$pkg/index.json" | jq -r '.items[0].items[0].catalogEntry | {version, dependencyGroups}'
done
Length of output: 489
Script:
#!/bin/bash
# Let's check the package versions defined in Directory.Packages.props
rg -A 1 "PackageVersion.*Include=\"(Microsoft\.NET\.Test\.Sdk|xunit|xunit\.runner)" Directory.Packages.props
# Also check global.json for SDK version
cat global.json || echo "global.json not found"
# Check if there are any conditional package references
rg "Condition.*TargetFramework.*net9" Directory.Build.props Directory.Packages.props
Length of output: 686
45-46: Verify package versions in Directory.Packages.props
The version removal for build tools looks good and aligns with centralized version management. Let's verify these packages are properly defined in the new central version file.
✅ Verification successful
✓ Package versions are properly defined in Directory.Packages.props
Both packages have their versions correctly defined in Directory.Packages.props:
- Microsoft.SourceLink.GitHub: 8.0.0
- MinVer: 6.0.0
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that the packages are defined in Directory.Packages.props
# Expected: Both packages should be found with version numbers
echo "Checking Directory.Packages.props for package versions..."
rg -A 1 "Microsoft\.SourceLink\.GitHub|MinVer" "Directory.Packages.props"
Length of output: 405
| ## [9.0.0] - 2024-11-13 | ||
|
|
||
| This major release is first and foremost focused on ironing out any wrinkles that have been introduced with .NET 9 preview releases so the final release is production ready together with the official launch from Microsoft. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance documentation for major version 9.0.0.
For a major version release (9.0.0), consider adding more detailed documentation under standard sections (Added, Changed, Removed, etc.) to help users understand:
- Breaking changes (if any)
- New features or improvements
- Deprecated functionality
- Migration guide from version 8.x
🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... introduced with .NET 9 preview releases so the final release is production ready t...
(COMMA_COMPOUND_SENTENCE_2)
| > Changelog entries prior to version 8.4.0 was migrated from previous versions of Codebelt.Extensions.Swashbuckle.AspNetCore. | ||
| ## [9.0.0] - TBD | ||
| ## [9.0.0] - 2024-11-13 |
There was a problem hiding this comment.
💡 Codebase verification
Release date needs adjustment to align with .NET 9 GA
The planned release date of November 13, 2024, appears premature since:
- The codebase is already targeting
net9.0, which is currently in preview - The changelog explicitly mentions waiting for "official launch from Microsoft"
- Microsoft typically releases new major .NET versions in November, but usually later in the month
- .NET 8 was released on November 14, 2023, suggesting .NET 9 GA would likely be mid-to-late November 2024
Consider adjusting the release date to be after .NET 9's General Availability to ensure production readiness.
🔗 Analysis chain
Verify the planned release date.
The release date (2024-11-13) aligns with the PR objectives. However, since this is a future date, please ensure it's coordinated with the .NET 9 release schedule from Microsoft.
Let me gather more information about .NET 9 mentions and version details to better verify the release timeline.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the release date aligns with .NET 9 release timeline
# by searching for any mentions of release dates in the repository
rg -i "release.*date|launch.*date|net.*9.*release|net.*9.*launch" --type md
Length of output: 313
Script:
#!/bin/bash
# Search for .NET 9 related information in the codebase
rg -i "net\s*9|dotnet\s*9" --type-add 'config:*.{json,props,csproj}' --type md --type config -A 3
# Also check package references and target frameworks
fd -e csproj -x cat {} \; | grep -i "TargetFramework\|Version"
Length of output: 1058
1 participant
This pull request includes several updates to package references and project configuration files to centralize version management and remove specific version numbers from individual project files.
Centralized Version Management:
Directory.Packages.propsfile to manage package versions centrally. This file includes version specifications for several packages used across the project.Package Reference Updates:
PackageReferenceelements inDirectory.Build.propsfor both non-test and test projects. [1] [2]PackageReferenceelements insrc/Codebelt.Extensions.Swashbuckle.AspNetCore/Codebelt.Extensions.Swashbuckle.AspNetCore.csprojto remove specific version numbers.PackageReferenceelements intest/Codebelt.Extensions.Swashbuckle.AspNetCore.Tests/Codebelt.Extensions.Swashbuckle.AspNetCore.Tests.csprojto remove specific version numbers.Changelog Update:
CHANGELOG.mdto 2024-11-13.Summary by CodeRabbit
New Features
Bug Fixes
Chores