Skip to content

Pin japicmp baseline in version.gradle.kts#8591

Merged
jack-berg merged 5 commits into
open-telemetry:mainfrom
trask:pin-japicmp-baseline
Jul 13, 2026
Merged

Pin japicmp baseline in version.gradle.kts#8591
jack-berg merged 5 commits into
open-telemetry:mainfrom
trask:pin-japicmp-baseline

Conversation

@trask

@trask trask commented Jul 11, 2026

Copy link
Copy Markdown
Member

Pin the API diff baseline in version.gradle.kts and 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.

@codecov

codecov Bot commented Jul 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.60%. Comparing base (1588a31) to head (1b371e1).
⚠️ Report is 4 commits behind head on main.

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

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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 apidiffBaselineVersion in version.gradle.kts and exports it via extra for 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.

Comment thread version.gradle.kts Outdated
@opentelemetry-pr-dashboard

Copy link
Copy Markdown

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.

Comment thread version.gradle.kts Outdated
@@ -1,4 +1,5 @@
val snapshot = true
val apidiffBaselineVersion = "1.63.0"

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.

will want to bump this to 1.64.0 after #8586 is merged

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

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

Comment thread .github/scripts/get-version.sh Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

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

Comment thread .github/workflows/release.yml

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

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

Comment thread buildSrc/src/main/kotlin/otel.japicmp-conventions.gradle.kts

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@trask trask marked this pull request as ready for review July 11, 2026 06:02
@trask trask requested a review from a team as a code owner July 11, 2026 06:02
@jack-berg jack-berg merged commit ebbb954 into open-telemetry:main Jul 13, 2026
28 checks passed
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