Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ref #612: Use detachedConfiguration() to cleanly resolve old API artifact with Gradle 8.2+ #663

Closed
wants to merge 1 commit into from
Closed

Ref #612: Use detachedConfiguration() to cleanly resolve old API artifact with Gradle 8.2+ #663

wants to merge 1 commit into from

Conversation

jbonofre
Copy link

@jbonofre jbonofre commented Jun 21, 2024 •
edited
Loading

Before this PR

With Gradle 8.2+, revapi plugin doesn't detect any ABI/API breaks.
The reason is because it doesn't resolve the right artifacts for the old API: it always compares new API with new API.
The old API artifact is actually resolved using the project version (so the SNAPSHOT version) instead of the old version defined.

After this PR

Using detachedConfiguration() in the OldApiConfigurations allow to not get the project default artifact but actually the old API one (correct).

Possible downsides?

This change works with any Gradle version. The only downside with detachedConfiguration() is when using --configuration-cache as detached configurations can't be cached.

This closes #612

@palantirtech
Copy link
Member

Thanks for your interest in palantir/gradle-revapi, @jbonofre! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request.

@changelog-app
Copy link

changelog-app bot commented Jun 21, 2024

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Ref #612: Use detachedConfiguration() to cleanly resolve old API artifact with Gradle 8.2+

Check the box to generate changelog(s)

  • Generate changelog entry

@jbonofre jbonofre mentioned this pull request Jun 21, 2024
Merged
@jbonofre jbonofre closed this by deleting the head repository Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

revapi plugin doesn't detect change after upgrading to gradle 8.2.0/8.3.0
2 participants
@jbonofre @palantirtech