Afischbacher / Nhl.Api

The Official Unofficial .NET NHL API
MIT License
26 stars 3 forks source link

v3.4.0 #52

Closed Afischbacher closed 7 months ago

Afischbacher commented 7 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 7 months ago
Walkthrough ## Walkthrough The update to the NHL API involves transitioning to .NET framework 8.0, improving player and goalie statistics retrieval, refining method parameters for clarity, enhancing project structure and testing, adjusting HTTP client and service instantiation, and streamlining .NET setup in GitHub workflows by exclusively targeting version 8. These changes signify a comprehensive effort to modernize the API's infrastructure and functionalities. ## Changes | File Path | Change Summary | |-----------|----------------| | `Nhl.Api.Common/Nhl.Api.Common.csproj`
`Nhl.Api.Domain/Nhl.Api.Domain.csproj`
`Nhl.Api.Tests/Nhl.Api.Tests.csproj`
`Nhl.Api/Nhl.Api.csproj` | Updated project versions to `3.4.0` and targeted .NET framework 8.0. | | `Nhl.Api.Domain/Enumerations/Player/PlayerEnum.cs`
`Nhl.Api.Tests/GlobalUsings.cs` | Added namespace declarations for player enumerations and global usings. | | `Nhl.Api.Tests/PlayerTests.cs`
`Nhl.Api.Tests/StringTests.cs` | Enhanced project structure and string manipulation tests. | | `Nhl.Api/Src/GameApi/INhlGameApi.cs`
`Nhl.Api/Src/GameApi/NhlGameApi.cs`
`Nhl.Api/Src/GlobalUsings.cs`
`Nhl.Api/Src/LeagueApi/INhlLeagueApi.cs`
`Nhl.Api/Src/LeagueApi/NhlLeagueApi.cs`
`Nhl.Api/Src/PlayerApi/INhlPlayerApi.cs`
`Nhl.Api/Src/PlayerApi/NhlPlayerApi.cs`
`Nhl.Api/Src/StatisticsApi/INhlStatisticsApi.cs`
`Nhl.Api/Src/StatisticsApi/NhlStatisticsApi.cs` | Introduced and updated methods for player and goalie statistics, modified method signatures, and refined parameter validations. | | `.github/workflows/develop-build.yml`
`.github/workflows/master-build-daily.yml`
`.github/workflows/master-build.yml`
`.github/workflows/publish-nuget.yml` | Simplified .NET setup to exclusively target version 8 in GitHub Actions workflows. | ## Poem > In the code where data flows, 🐾 > A rabbit hopped, and change arose. > With .NET 8 in its sight, > It leaped through code, both day and night. > "To modernize," it softly said, > "Is to ensure the API's ahead." > In bytes and bits, it danced with glee, > For version 3.4.0 was key. 🚀

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?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

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 .` - `Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
codecov[bot] commented 7 months ago

Codecov Report

Attention: Patch coverage is 78.26087% with 50 lines in your changes are missing coverage. Please review.

Project coverage is 88.70%. Comparing base (b0e9cfd) to head (7195c33). Report is 8 commits behind head on master.

Files Patch % Lines
...ain/Models/Player/ExpressionPlayerFilterBuilder.cs 56.52% 17 Missing and 3 partials :warning:
...ain/Models/Player/ExpressionGoalieFilterBuilder.cs 66.66% 11 Missing and 5 partials :warning:
Nhl.Api/Src/PlayerApi/NhlPlayerApi.cs 76.92% 0 Missing and 6 partials :warning:
Nhl.Api/Src/StatisticsApi/NhlStatisticsApi.cs 86.48% 1 Missing and 4 partials :warning:
Nhl.Api/Src/LeagueApi/NhlLeagueApi.cs 50.00% 0 Missing and 3 partials :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #52 +/- ## ========================================== + Coverage 88.17% 88.70% +0.53% ========================================== Files 72 75 +3 Lines 3112 3276 +164 Branches 419 438 +19 ========================================== + Hits 2744 2906 +162 + Misses 305 303 -2 - Partials 63 67 +4 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.