Receive Problems API event at Gradle Plugin

ganadist · September 7, 2024, 4:06pm

I’m trying to add annotation with Github actions workflow.

It looks recent Gradle provides Problems API to describe errors to IDEs.
And I found sample code in here.

In sample, Problem event can be receive from Gradle Tooling API which is used on IDE.
But is it possible to receive these events in Gradle itself?

If it is possible, it might be very easy to implement Present summary of errors and warnings reported via Problems API · Issue #30 · gradle/actions · GitHub

Vampire · September 7, 2024, 6:16pm

I’m not 100% sure, but I don’t think so

donat · September 12, 2024, 3:22pm

Currently there’s no public API for consuming problems. Problem reports are emitted via build operation progress events. You could register a new listener via the BuildOperationListenerManager service, but it’s internal API and I’d suggest not to use it.

The Problems API maturation is on our roadmap and as part of it, we’ll consider a consumer API in Gradle.

ganadist · September 20, 2024, 11:57am

Issue was opened.

github.com/gradle/gradle

Problems API should be available to plugin authors

opened 03:27PM - 19 Sep 24 UTC

joshfriend

a:feature to-triage

### Expected Behavior I'd like to be able to collect build problems inside of a… plugin. ### Current Behavior (optional) The [problems API](https://docs.gradle.org/current/javadoc/org/gradle/api/problems/Problems.html) is only available via the tooling api, so I cannot write a plugin that adds a problem listener to the build. ### Context Specific use case would be to add configuration cache miss reason to a custom value in the build scan, which would allow us to easily export that data from the develocity api for analysis. I'm aware that develocity has a new api for configuration cache info that includes the miss reasons, but calling that API does not scale well for how many scans we produce. This api seems generally useful beyond my specific example though, for example we could create a plugin that creates a condensed build report with error info and specific resolution steps.