From 6bf24dfe8ac32cfd0c6d17b939d4c59efcc34be3 Mon Sep 17 00:00:00 2001 From: Thomas Himmelstoss <9889638+tfkhim@users.noreply.github.com> Date: Sat, 30 Nov 2024 09:55:46 +0100 Subject: [PATCH] docs(gradle): add a section about Gradle plugin support (#32773) --- docs/usage/java.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/usage/java.md b/docs/usage/java.md index bec5049480..e3de7de7ff 100644 --- a/docs/usage/java.md +++ b/docs/usage/java.md @@ -46,6 +46,18 @@ Renovate does not support: - Catalogs with custom names that do not end in `.toml` - Catalogs outside the `gradle` folder whose names do not end in `.versions.toml` (unless overridden via [`fileMatch`](./configuration-options.md#filematch) configuration) +### Gradle Plugin Support + +Renovate can also update [Gradle plugins](https://docs.gradle.org/current/userguide/plugins.html). +It supports the `id(<pluginId>)` syntax as well as the `kotlin(<kotlinPluginId>)` shortcut for `id(org.jetbrains.kotlin.<kotlinPluginId>)`. + +For specifying `packageRules` it is important to know how `depName` and `packageName` are defined for a Gradle plugin: + +- The `depName` field is equal to `<pluginId>` +- The `packageName` field is equal to `<pluginId>:<pluginId>.gradle.plugin` + +This is a direct consequence of the [Plugin Marker Artifact](https://docs.gradle.org/current/userguide/plugins.html#sec:plugin_markers) naming convention. + ## Gradle Wrapper Renovate can update the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) of a project. -- GitLab