Skip to content

Conversation

@rhamzeh
Copy link
Member

@rhamzeh rhamzeh commented Oct 1, 2025

Description

  • feat!: add support for .NET Standard 2.0, .NET 8.0 and .NET 9.0

Warning

BREAKING CHANGES:

  • While we have dropped .NET 6.0 as a target framework, the SDK now supports .NET Standard > 2.0 - which means it can still be used in .NET 6.0 projects.
  • We have updated the underlying OpenAPI generator to a newer version, which has caused some changes in the generated code. Below is a summary of the changes:
Old Name New Name Affected Models
_Nodes VarNodes Nodes (and related constructors/references)
_Users VarUsers Users (and related constructors/references)
_base VarBase Difference, UsersetTreeDifference
_object VarObject CheckRequestTupleKey, ExpandRequestTupleKey, TupleKey, TupleKeyWithoutCondition, FgaObject, ObjectRelation, ReadRequestTupleKey, User
_this VarThis Userset
UNSPECIFIED TYPENAMEUNSPECIFIED TypeName (and other members in this enum)
Old Enum Value New Enum Value Affected Enum
WRITE TUPLEOPERATIONWRITE TupleOperation
DELETE TUPLEOPERATIONDELETE TupleOperation

What problem is being solved?

How is it being solved?

What changes are made to solve it?

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

  • Documentation

    • Added a Supported Frameworks section outlining target frameworks and policy.
    • Introduced a comprehensive SUPPORTED_FRAMEWORKS guide with support policy, CI/test matrix, troubleshooting, and FAQ.
    • Updated CHANGELOG with v0.7.0 entry (including note on added support for .NET Standard 2.0, .NET 8.0, and .NET 9.0) and timestamp.
  • Chores

    • Bumped package version to 0.7.0.
    • Updated default User-Agent string to reflect the new version.

@rhamzeh rhamzeh added the release label Oct 1, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 1, 2025

Walkthrough

Updates documentation to reflect new framework targets and support policy, adds a new SUPPORTED_FRAMEWORKS.md, and updates CHANGELOG for v0.7.0. Bumps package version to 0.7.0 and updates the default User-Agent and public Version constant in Configuration.cs. No functional code changes beyond metadata/version strings.

Changes

Cohort / File(s) Summary of changes
Documentation
CHANGELOG.md, README.md, SUPPORTED_FRAMEWORKS.md
Added v0.7.0 entry with date; introduced Supported Frameworks section; added detailed support policy/matrix and FAQs for targets.
SDK Version Constants
src/OpenFga.Sdk/Configuration/Configuration.cs
Updated public Version constant to "0.7.0" and DefaultUserAgent string to "openfga-sdk dotnet/0.7.0".
Project Metadata
src/OpenFga.Sdk/OpenFga.Sdk.csproj
Bumped package version from 0.6.0 to 0.7.0.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • release: v0.6.0 #125 — Also updates Configuration.cs version/User-Agent and OpenFga.Sdk.csproj package version, indicating overlapping version bump changes.

Suggested reviewers

  • evansims

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title “release: v0.7.0” clearly and concisely identifies the primary purpose of this pull request, which is to publish version 0.7.0 of the SDK. It avoids unnecessary detail while accurately reflecting the main change from the developer’s perspective.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch release/v0.7.0

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Base automatically changed from feat/dotnet-standard2.0 to main October 1, 2025 18:55
@rhamzeh rhamzeh marked this pull request as ready for review October 1, 2025 19:09
@rhamzeh rhamzeh requested review from a team as code owners October 1, 2025 19:09
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)
README.md (1)

94-103: Helpful framework support documentation added.

The new "Supported Frameworks" section provides clear guidance on supported targets and the support policy. The reference to SUPPORTED_FRAMEWORKS.md for detailed information is appropriate.

Minor: Markdown lint issue on line 99.

The bare URL should be wrapped in angle brackets to comply with markdown best practices:

-https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core
+<https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core>
SUPPORTED_FRAMEWORKS.md (1)

15-15: Minor: Markdown lint issue on line 15.

The bare URL should be wrapped in angle brackets to comply with markdown best practices:

-https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core
+<https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core>
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f6db0a and 61223cf.

📒 Files selected for processing (5)
  • CHANGELOG.md (1 hunks)
  • README.md (2 hunks)
  • SUPPORTED_FRAMEWORKS.md (1 hunks)
  • src/OpenFga.Sdk/Configuration/Configuration.cs (1 hunks)
  • src/OpenFga.Sdk/OpenFga.Sdk.csproj (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md

99-99: Bare URL used

(MD034, no-bare-urls)

SUPPORTED_FRAMEWORKS.md

15-15: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: Analyze (csharp)
  • GitHub Check: Test netcoreapp3.1 on windows-latest
  • GitHub Check: Test net48 on windows-latest
  • GitHub Check: Test net8.0 on windows-latest
🔇 Additional comments (5)
src/OpenFga.Sdk/OpenFga.Sdk.csproj (1)

16-16: Version bump looks good.

The package version update to 0.7.0 is consistent with the changes in Configuration.cs and aligns with the CHANGELOG entry.

CHANGELOG.md (1)

5-28: Well-documented release notes.

The v0.7.0 changelog entry clearly describes the framework support changes and provides a comprehensive migration guide for the breaking changes. The detailed tables for renamed models and enum values will be helpful for users upgrading.

src/OpenFga.Sdk/Configuration/Configuration.cs (1)

78-80: Version constants updated correctly.

Both the public Version constant and the DefaultUserAgent string are now consistent with the package version bump to 0.7.0.

SUPPORTED_FRAMEWORKS.md (2)

1-85: Excellent framework support documentation.

This comprehensive documentation provides clear guidance on:

  • Supported framework targets and their rationale
  • Support policy aligned with Microsoft's lifecycle
  • CI/test coverage matrix
  • Target addition/removal criteria
  • Troubleshooting guidance and FAQ

The structure and content will help users understand the framework support strategy and make informed decisions.


27-27: Confirmed workflow file reference is correct The file .github/workflows/main.yaml exists; no updates needed.

@rhamzeh rhamzeh requested a review from evansims October 1, 2025 19:24
@rhamzeh rhamzeh added this pull request to the merge queue Oct 1, 2025
Merged via the queue into main with commit 65a38bc Oct 1, 2025
23 checks passed
@rhamzeh rhamzeh deleted the release/v0.7.0 branch October 1, 2025 19:51
@coderabbitai coderabbitai bot mentioned this pull request Oct 14, 2025
4 tasks
@dyeam0 dyeam0 linked an issue Oct 22, 2025 that may be closed by this pull request
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support for .NET Standard 2.0

3 participants