Skip to content

chore(model): Consistently make comments for reasons optional - #11643

Open
sschuberth wants to merge 1 commit into
mainfrom
reason-comment-optional
Open

chore(model): Consistently make comments for reasons optional#11643
sschuberth wants to merge 1 commit into
mainfrom
reason-comment-optional

Conversation

@sschuberth

Copy link
Copy Markdown
Member

No description provided.

Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
@sschuberth
sschuberth requested a review from a team as a code owner March 30, 2026 07:31
@sschuberth
sschuberth enabled auto-merge (rebase) March 30, 2026 07:32
@codecov

codecov Bot commented Mar 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.37%. Comparing base (c4fb3e0) to head (8ac7dba).
⚠️ Report is 1024 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #11643      +/-   ##
============================================
- Coverage     58.39%   58.37%   -0.02%     
  Complexity     1759     1759              
============================================
  Files           355      355              
  Lines         13204    13207       +3     
  Branches       1307     1307              
============================================
  Hits           7710     7710              
- Misses         5007     5010       +3     
  Partials        487      487              
Flag Coverage Δ
funTest-external-tools 14.74% <0.00%> (-0.01%) ⬇️
funTest-no-external-tools 30.57% <0.00%> (-0.02%) ⬇️
test-ubuntu-24.04 42.25% <100.00%> (-0.02%) ⬇️
test-windows-2025 42.23% <100.00%> (-0.02%) ⬇️

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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

* An optional comment to further explain why the [reason] is applicable here.
*/
val comment: String? = null
val comment: String = ""

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is a breaking change if the class is used for deserialization of config files.

* An optional comment to further explain why the [reason] is applicable here.
*/
val comment: String
val comment: String = ""

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

IIRC it was on purpose that resolution comments must be set, even though it was not verified that they are not empty. Changing that should be explained in the commit message and I think docs should also be updates (for example, make clear that comments are optional in the resolution docs).

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