ProblemGroups

The problem groups: the predefined hierarchy, and the entry point for creating sub-groups below it.

Problems are organized in a fixed hierarchy of root groups, each with predefined sub-groups. Producers place a problem in the most specific predefined group matching the activity the problem is about, or create their own sub-group below a predefined group when none matches. Group names describe what a problem is about, not where or when it happened.

To pick a group:

  • Find the root group matching the activity (for example getCompilation for compiler problems).
  • Find the matching predefined sub-group and report the problem there, for example problems.getGroups().getCompilation().getJava().problemId("Unused import").
  • If no predefined sub-group matches, create one with group, for example problems.getGroups().getTransformation().group("KMP").problemId("..."), or use the Undefined sub-group.
  • If no root group matches, create a sub-group below getOthers, or use its Undefined sub-group.
If several groups match, pick the one closest to the context of the producer.

Group names are case-sensitive. Creating a group with the exact name of a predefined sibling returns the predefined group; any other name creates a new group. The name Undefined is reserved for the synthetic Undefined groups.

Not intended for implementation outside of Gradle. New members may be added in future versions.

The hierarchy and the descriptions below are also listed in the "Predefined problem groups" section of the user guide (reporting_problems.adoc); update that table whenever a predefined group or a description changes.

Since

9.9.0

See also

Functions

Link copied to clipboard
The Compilation root group.
Link copied to clipboard
The Delivery root group.
Link copied to clipboard
The Dependencies root group.
Link copied to clipboard
The Documentation root group.
Link copied to clipboard
The External Processes root group.
Link copied to clipboard
The Gradle root group.
Link copied to clipboard
The Others root group.
Link copied to clipboard
The Packaging root group.
Link copied to clipboard
The Provisioning root group.
Link copied to clipboard
The Transformation root group.
Link copied to clipboard
The Verification root group.