palantir / gradle-baseline

A set of Gradle plugins that configure default code quality tools for developers.
Apache License 2.0
299 stars 135 forks source link

baseline-java-versions: Support Gradle 8.6+ by not inspecting publications #2820

Closed CRogers closed 2 months ago

CRogers commented 2 months ago

Before this PR

baseline-java-versions does not work in Gradle 8.6+. This error is produced:

   > Circular evaluation detected: task ':log-receiver-api:log-receiver-api-dialogue:compileJava' property 'javaCompiler'
      -> map(org.gradle.jvm.toolchain.JavaCompiler flatmap(map(property(com.palantir.baseline.plugins.javaversions.ChosenJavaVersion, map(com.palantir.baseline.plugins.javaversions.ChosenJavaVersion provider(?) check-type())))) check-type())
      -> flatmap(map(property(com.palantir.baseline.plugins.javaversions.ChosenJavaVersion, map(com.palantir.baseline.plugins.javaversions.ChosenJavaVersion provider(?) check-type()))))
      -> map(property(com.palantir.baseline.plugins.javaversions.ChosenJavaVersion, map(com.palantir.baseline.plugins.javaversions.ChosenJavaVersion provider(?) check-type())))
      -> property(com.palantir.baseline.plugins.javaversions.ChosenJavaVersion, map(com.palantir.baseline.plugins.javaversions.ChosenJavaVersion provider(?) check-type()))
      -> map(com.palantir.baseline.plugins.javaversions.ChosenJavaVersion provider(?) check-type())
      -> provider(?)
      -> set(interface org.gradle.api.publish.maven.MavenArtifact, org.gradle.api.internal.provider.AbstractCollectionProperty$CollectingSupplier@48eab27f)
      -> map(property 'component')
      -> provider(?)
      -> task ':log-receiver-api:log-receiver-api-dialogue:compileJava' property 'javaCompiler'

On further inspection, it appears that accessing information about the MavenArtifacts for jars in the maven publishing extension requires forcing the javaCompiler property the compile task in Gradle 8.6+. Since we use info from MavenArtifact to configure the javaCompiler property (checking to see whether there are any jar artifacts), this makes an unresolvable circular evaluation.

After this PR

==COMMIT_MSG== Prevent "Circular evaluation detected" error when using baseline-java-versions on Gradle 8.6+. ==COMMIT_MSG==

We avoid this by just not looking the published artifacts. Instead, we expand the list of known library and known distribution plugins and only check with them.

Possible downsides?

changelog-app[bot] commented 2 months ago

Generate changelog in changelog-dir>`changelog/@unreleased`</changelog-dir

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 - [x] Fix - [ ] Break - [ ] Deprecation - [ ] Manual task - [ ] Migration

Description

Prevent "Circular evaluation detected" error when using baseline-java-versions on Gradle 8.6+. **Check the box to generate changelog(s)** - [x] Generate changelog entry
felixdesouza commented 2 months ago

👍

svc-autorelease commented 2 months ago

Released 5.58.0