Skip to content

GROOVY-12038: Graduate groovy-contracts from incubating to stable#2563

Merged
paulk-asert merged 1 commit into
apache:masterfrom
paulk-asert:groovy12038
May 25, 2026
Merged

GROOVY-12038: Graduate groovy-contracts from incubating to stable#2563
paulk-asert merged 1 commit into
apache:masterfrom
paulk-asert:groovy12038

Conversation

@paulk-asert
Copy link
Copy Markdown
Contributor

No description provided.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.1929%. Comparing base (3818298) to head (9ddd8df).
⚠️ Report is 7 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@                Coverage Diff                 @@
##               master      #2563        +/-   ##
==================================================
+ Coverage     68.1890%   68.1929%   +0.0040%     
- Complexity      33094      33097         +3     
==================================================
  Files            1508       1508                
  Lines          126148     126148                
  Branches        22888      22888                
==================================================
+ Hits            86019      86024         +5     
+ Misses          32487      32485         -2     
+ Partials         7642       7639         -3     

see 5 files with indirect coverage changes

🚀 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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Graduates core groovy-contracts annotations from incubating to stable by removing @Incubating markers and updating the user guide/package docs accordingly, while also expanding the documentation and spec examples for loop termination measures via @Decreases.

Changes:

  • Remove @Incubating from core contract annotations (@Requires, @Ensures, @Invariant) and their repeatable container annotations; add/clarify @since and Javadoc.
  • Update contracts user guide to document @Contracted enablement and add a new @Decreases section with spec-backed examples.
  • Refresh groovy.contracts package-level documentation to distinguish stable vs incubating annotations.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
subprojects/groovy-contracts/src/spec/test/ContractsTest.groovy Adds tagged spec examples for @Decreases on while/for loops for inclusion in docs.
subprojects/groovy-contracts/src/spec/doc/contracts-userguide.adoc Documents @Contracted, adds @Decreases feature + section, updates feature list terminology.
subprojects/groovy-contracts/src/main/java/groovy/contracts/RequiresConditions.java Removes @Incubating; improves container-annotation Javadoc and adds @since.
subprojects/groovy-contracts/src/main/java/groovy/contracts/Requires.java Removes @Incubating; adds @since and keeps API stable.
subprojects/groovy-contracts/src/main/java/groovy/contracts/package-info.java Reworks package Javadoc to explicitly list stable vs incubating annotations.
subprojects/groovy-contracts/src/main/java/groovy/contracts/Invariants.java Removes @Incubating; improves container-annotation Javadoc and adds @since.
subprojects/groovy-contracts/src/main/java/groovy/contracts/Invariant.java Removes @Incubating; adds @since and keeps API stable.
subprojects/groovy-contracts/src/main/java/groovy/contracts/EnsuresConditions.java Removes @Incubating; improves container-annotation Javadoc and adds @since.
subprojects/groovy-contracts/src/main/java/groovy/contracts/Ensures.java Removes @Incubating; adds @since and keeps API stable.
subprojects/groovy-contracts/src/main/java/groovy/contracts/Contracted.java Adds @since to the marker annotation Javadoc.

Comment thread subprojects/groovy-contracts/src/spec/doc/contracts-userguide.adoc Outdated
@testlens-app

This comment has been minimized.

@paulk-asert paulk-asert merged commit 42ce7e0 into apache:master May 25, 2026
28 checks passed
@paulk-asert paulk-asert deleted the groovy12038 branch May 25, 2026 04:48
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.

3 participants