Skip to content

V0.4.1/package maintenance #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 31, 2025
Merged

V0.4.1/package maintenance #11

merged 4 commits into from
Jan 31, 2025

Conversation

gimlichael
Copy link
Member

@gimlichael gimlichael commented Jan 31, 2025

This pull request includes multiple updates across various files to keep dependencies up-to-date, update framework versions, and ensure the copyright information is current.

Dependency and Framework Updates:

  • Updated nginx base image version in .docfx/Dockerfile.docfx from 1.27.0-alpine to 1.27.3-alpine.
  • Updated target framework in .docfx/docfx.json from net8.0 to net9.0.
  • Updated various package versions in Directory.Packages.props to their latest versions.

Metadata and Documentation Updates:

  • Updated _appFooter in .docfx/docfx.json to reflect the year 2025.
  • Added a new version entry 0.4.1 in CHANGELOG.md and PackageReleaseNotes.txt to document the latest release. [1] [2]
  • Added a link to full documentation in README.md.

Miscellaneous Updates:

  • Updated copyright year in LICENSE.md and Directory.Build.props. [1] [2]
  • Updated dockerImage in testenvironments.json to a newer version.

Summary by CodeRabbit

Release Notes v0.4.1

  • New Features

    • Added documentation link in README
    • Extended project availability to .NET 9
  • Dependency Updates

    • Updated multiple package versions
    • Updated test runner and SDK dependencies
  • Documentation

    • Updated copyright year to 2024-2025
    • Generated documentation now available online
  • Chores

    • Updated base Docker image
    • Updated test environment Docker image

@gimlichael gimlichael self-assigned this Jan 31, 2025
Copy link

coderabbitai bot commented Jan 31, 2025

Walkthrough

This pull request encompasses a comprehensive update across multiple configuration and documentation files. The changes primarily focus on version updates, copyright year extensions, and framework compatibility. Key modifications include updating Nginx base image version, transitioning to .NET 9, extending copyright notices from 2024 to 2024-2025, updating package dependencies, and adding a documentation link in the README.

Changes

File Change Summary
.docfx/Dockerfile.docfx Nginx base image updated from 1.27.0-alpine to 1.27.3-alpine
.docfx/docfx.json - TargetFramework changed from net8.0 to net9.0
- Copyright year updated to 2024-2025
.nuget/Codebelt.SharedKernel/PackageReleaseNotes.txt - Version bumped to 0.4.1
- Added .NET 9 availability
CHANGELOG.md New version 0.4.1 entry added for January 31, 2025
Directory.Build.props - Copyright year extended to 2024-2025
- Removed Microsoft.SourceLink.GitHub package reference
Directory.Packages.props Multiple package versions updated (e.g., Cuemon, Xunit, coverlet)
LICENSE.md Copyright notice updated to 2024-2025
README.md Added DocFx documentation link
testenvironments.json Docker image version updated to net8.0.405-9.0.102

Possibly related PRs

Poem

🐰 Hop, hop, version update time!
Code grows, dependencies align
From eight to nine, we gently glide
Copyright spans a broader stride
Rabbit's tech dance, smooth and fine! 🚀


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
.nuget/Codebelt.SharedKernel/PackageReleaseNotes.txt (1)

1-5: Consider simplifying the dependency update note.

The release notes are well-structured, but the language could be more concise.

Consider this simpler phrasing:

-CHANGED Dependencies to latest and greatest with respect to TFMs
+CHANGED Dependencies to latest versions for all target frameworks
🧰 Tools
🪛 LanguageTool

[style] ~5-~5: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...GED Dependencies to latest and greatest with respect to TFMs   Version: 0.4.0 Availability: .NE...

(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)

README.md (1)

9-10: Format the documentation URL using markdown syntax.

To improve accessibility and follow markdown best practices, please format the documentation URL using markdown link syntax.

Apply this diff to fix the formatting:

-Full documentation (generated by [DocFx](https://github.com/dotnet/docfx)) located here: https://sharedkernel.codebelt.net/
+Full documentation (generated by [DocFx](https://github.com/dotnet/docfx)) is available [here](https://sharedkernel.codebelt.net/).
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

9-9: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aac2364 and 75f64de.

📒 Files selected for processing (9)
  • .docfx/Dockerfile.docfx (1 hunks)
  • .docfx/docfx.json (2 hunks)
  • .nuget/Codebelt.SharedKernel/PackageReleaseNotes.txt (1 hunks)
  • CHANGELOG.md (1 hunks)
  • Directory.Build.props (1 hunks)
  • Directory.Packages.props (1 hunks)
  • LICENSE.md (1 hunks)
  • README.md (1 hunks)
  • testenvironments.json (1 hunks)
✅ Files skipped from review due to trivial changes (4)
  • LICENSE.md
  • .docfx/Dockerfile.docfx
  • testenvironments.json
  • CHANGELOG.md
🧰 Additional context used
🪛 LanguageTool
.nuget/Codebelt.SharedKernel/PackageReleaseNotes.txt

[style] ~5-~5: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...GED Dependencies to latest and greatest with respect to TFMs   Version: 0.4.0 Availability: .NE...

(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)

🪛 markdownlint-cli2 (0.17.2)
README.md

9-9: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: 🧪 Test (windows-2022, Release)
  • GitHub Check: 🧪 Test (windows-2022, Debug)
  • GitHub Check: 🧪 Test (ubuntu-22.04, Release)
  • GitHub Check: 🧪 Test (ubuntu-22.04, Debug)
  • GitHub Check: 📦 Pack (Debug)
🔇 Additional comments (3)
Directory.Packages.props (1)

6-17: Verify package version compatibility.

The package version updates appear to be minor increments, which is good for maintenance. Let's verify these versions are the latest stable releases and check for any compatibility issues.

✅ Verification successful

All package versions are up-to-date and compatible

The package versions specified in the PR are using the latest stable releases available on NuGet. No compatibility issues were found between the packages.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify package versions and check for any known compatibility issues

# Function to check NuGet package info
check_package() {
    local package=$1
    echo "Checking $package..."
    curl -s "https://api.nuget.org/v3/registration5-semver1/$package/index.json" | jq -r '.items[0].upper'
}

# Check latest versions for key packages
echo "Latest versions from NuGet:"
packages=(
    "Cuemon.Extensions.IO"
    "Codebelt.Extensions.Xunit.App"
    "Microsoft.NET.Test.Sdk"
    "Savvyio.Domain"
    "xunit"
    "xunit.runner.visualstudio"
)

for package in "${packages[@]}"; do
    check_package "$package"
done

Length of output: 2227


Script:

#!/bin/bash
# Description: Verify package versions using NuGet v3 catalog API

check_package() {
    local package=$1
    local version=$2
    echo "Checking $package@$version..."
    response=$(curl -s "https://api.nuget.org/v3-flatcontainer/$package/$version/$package.nuspec")
    if [[ $response == *"<version>$version</version>"* ]]; then
        echo "✓ Version exists"
    else
        echo "✗ Version not found"
    fi
}

# Check specific versions from the PR
declare -A packages=(
    ["Cuemon.Extensions.IO"]="9.0.1"
    ["Codebelt.Extensions.Xunit.App"]="9.0.1"
    ["Microsoft.NET.Test.Sdk"]="17.12.0"
    ["MinVer"]="6.0.0"
    ["Savvyio.Domain"]="4.0.1"
    ["xunit"]="2.9.3"
    ["xunit.runner.visualstudio"]="3.0.1"
)

for package in "${!packages[@]}"; do
    check_package "$package" "${packages[$package]}"
done

Length of output: 11115


Script:

#!/bin/bash
# Description: Search for packages using NuGet API

search_package() {
    local package=$1
    echo "Searching for $package..."
    curl -s "https://azuresearch-usnc.nuget.org/query?q=$package&prerelease=true&semVerLevel=2.0.0" | \
    jq -r '.data[0] | select(.id == "'$package'") | "Latest version: \(.version)\nVersions: \(.versions[].version)"'
}

packages=(
    "Savvyio.Domain"
    "Microsoft.NET.Test.Sdk"
    "Cuemon.Extensions.IO"
    "MinVer"
    "Codebelt.Extensions.Xunit.App"
)

for package in "${packages[@]}"; do
    search_package "$package"
    echo "---"
done

Length of output: 18880

Directory.Build.props (1)

16-16: LGTM! Copyright year updated appropriately.

The copyright year has been extended to include 2025, which aligns with the PR objectives.

.docfx/docfx.json (1)

15-15: LGTM! Framework and copyright updates are consistent.

The changes maintain consistency with other files:

  • TargetFramework updated to net9.0
  • Copyright year extended to 2024-2025 in the footer

Also applies to: 47-47

Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.50%. Comparing base (c09d767) to head (75f64de).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #11   +/-   ##
=======================================
  Coverage   88.50%   88.50%           
=======================================
  Files          11       11           
  Lines         200      200           
  Branches        8        8           
=======================================
  Hits          177      177           
  Misses         23       23           

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

@gimlichael gimlichael merged commit 4362c5f into main Jan 31, 2025
19 checks passed
@gimlichael gimlichael deleted the v0.4.1/package-maintenance branch January 31, 2025 21:22
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