Pin japicmp baseline in version.gradle.kts#8591
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8591 +/- ##
============================================
- Coverage 91.61% 91.60% -0.01%
+ Complexity 10315 10314 -1
============================================
Files 1013 1013
Lines 27274 27274
Branches 3202 3202
============================================
- Hits 24986 24984 -2
- Misses 1561 1562 +1
- Partials 727 728 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR pins the japicmp “old” (baseline) version in version.gradle.kts and threads it through the build so API diff checks compare against a stable baseline that can be updated atomically after releases.
Changes:
- Introduces
apidiffBaselineVersioninversion.gradle.ktsand exports it viaextrafor build logic. - Updates the japicmp Gradle conventions to use the pinned baseline instead of dynamically resolving
latest.release. - Updates documentation and the release workflow to bump the pinned baseline alongside regenerated API diff files.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| version.gradle.kts | Adds pinned apidiffBaselineVersion and publishes it via extra. |
| docs/knowledge/build.md | Documents that API diffs compare against the pinned baseline. |
| buildSrc/src/main/kotlin/otel.japicmp-conventions.gradle.kts | Switches japicmp baseline resolution to the pinned version. |
| .github/workflows/release.yml | Updates post-release automation to pin the baseline to the newly released version. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
This PR has review comments. Review suggestions, whether from maintainers or automated reviewers, aren't always correct or required. Please evaluate each comment on its merits, then make sure each thread has a clear outcome. For example, link to the commit if you applied a suggestion, explain why it wasn't applied, or ask a follow-up question. Automation flags a PR for human review once every review thread has a reply or is marked as resolved. Status across open PRs is visible on the pull request dashboard. |
| @@ -1,4 +1,5 @@ | |||
| val snapshot = true | |||
| val apidiffBaselineVersion = "1.63.0" | |||
There was a problem hiding this comment.
will want to bump this to 1.64.0 after #8586 is merged
Pin the API diff baseline in
version.gradle.ktsand update it together with the API diff files after each release. This prevents a new release from breaking API diff checks on open PRs.Port of open-telemetry/opentelemetry-java-instrumentation#18391.
#8587 (comment) made me remember this.