Skip to content

chore: add API compat checks#1992

Merged
toddbaert merged 1 commit into
mainfrom
chore/api-change-detection
Jul 14, 2026
Merged

chore: add API compat checks#1992
toddbaert merged 1 commit into
mainfrom
chore/api-change-detection

Conversation

@toddbaert

Copy link
Copy Markdown
Member
  • adds revapi check stage to "codequality" profile
  • detects bytecode and source deviations, and fails build requiring explicit exception addition in api-changes.json to pass.

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
@toddbaert toddbaert requested review from a team as code owners July 14, 2026 12:59
@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 05e7d5d8-1cc7-42fc-a782-6f7dd2f13a7e

📥 Commits

Reviewing files that changed from the base of the PR and between f630089 and 7ff3de9.

📒 Files selected for processing (3)
  • api-changes.json
  • pom.xml
  • src/main/java/dev/openfeature/sdk/FlagValueType.java

📝 Walkthrough

Walkthrough

The pull request adds Revapi API compatibility checks with documented exceptions for long-evaluation methods and reorders the existing FlagValueType enum constants.

Changes

API compatibility validation

Layer / File(s) Summary
Configure Revapi compatibility checks
pom.xml, api-changes.json
The codequality profile runs Revapi during verify, using Java analysis and configured exceptions for additive long-evaluation API differences.

Flag value type ordering

Layer / File(s) Summary
Reorder FlagValueType constants
src/main/java/dev/openfeature/sdk/FlagValueType.java
The existing enum constants are reordered to place LONG last without adding or removing constants.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding API compatibility checks.
Description check ✅ Passed The description matches the changeset by describing the new Revapi check stage and explicit exceptions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

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.

@sonarqubecloud

Copy link
Copy Markdown

Comment on lines +9 to +10
BOOLEAN,
LONG;

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The plugin found this ordinality improvement around our recent LONG support addition.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nice

@codecov

codecov Bot commented Jul 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.84%. Comparing base (f630089) to head (7ff3de9).

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1992      +/-   ##
============================================
+ Coverage     92.31%   92.84%   +0.52%     
- Complexity      706      707       +1     
============================================
  Files            60       60              
  Lines          1705     1705              
  Branches        195      195              
============================================
+ Hits           1574     1583       +9     
+ Misses           82       74       -8     
+ Partials         49       48       -1     
Flag Coverage Δ
unittests 92.84% <100.00%> (+0.52%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 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.

Comment on lines +9 to +10
BOOLEAN,
LONG;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nice

@toddbaert toddbaert merged commit 1f46ab3 into main Jul 14, 2026
11 checks passed
@toddbaert toddbaert deleted the chore/api-change-detection branch July 14, 2026 14:32
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.

2 participants