Skip to content

Commit

Permalink
Make Dokka plugin handling optional
Browse files Browse the repository at this point in the history
  • Loading branch information
rnc committed Oct 17, 2022
1 parent f6d4432 commit bc68db7
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
28 changes: 28 additions & 0 deletions guide/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,31 @@ GME supports handling this plugin through the CLI tool *only*. If this plugin is
establish the actual version via the [printVersion](https://github.com/vivin/gradle-semantic-build-versioning#printversion)
command, inserting that into the `gradle.properties`. Finally it will remove the plugin to ensure the version
is kept static.


### Dokka Plugin

Special handling has been included for the [dokka](https://github.com/Kotlin/dokka/) plugin in
order to inject the correct settings for earlier versions which did not respect proxy settings.

It is possible to disable this through the configuration key `dokkaPlugin` (default: true)

<table bgcolor="#ffff00">
<tr>
<td>
<code>dokkaPlugin</code> is available from version 3.9
</td>
</tr>
</table>

#### [Gradle Maven Publish Plugin](https://github.com/vanniktech/gradle-maven-publish-plugin)

The gradle-maven-publish-plugin implicitly injects other plugins such as the signing and dokka
plugins. In version 0.8.0 it injects 0.9.17 of the Dokka plugin. Currently GME is not able to change
this injected version to 0.9.18 (unlike a directly included 0.9.17 version) and therefore this can
lead to problems with the GME injected ode. It is currently recommended that the version is changed
from 0.8.0 to >= 0.9.0 which injects the dokka plugin at version 0.9.18.

#### Publish Plugin Hook

Certain project builds don't apply the publish plugin directly (be it the legacy or current one); instead they implement their own 'build plugin' (e.g. within `buildSrc`) that itself then applies plugins. This can lead to the situation where this custom plugin is applied and actioned after the GME tooling plugin which therefore does not detect any publishing plugins. It is possible to list those custom plugins as 'hooks' that GME will detect, and attempt to customise the publishing again. It is a comma separated list with a single default entry of `elasticsearch.esplugin`.
4 changes: 0 additions & 4 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,6 @@ Even though the alignment is successful at this point, the build itself will fai

For more details on Gradle dependencies and configurations, see [Declaring dependencies](https://docs.gradle.org/current/userguide/declaring_dependencies.html) and [Resolvable and consumable configurations](https://docs.gradle.org/current/userguide/declaring_dependencies.html#sec:resolvable-consumable-configs) in the Gradle user manual.

#### Publish Plugin Hook

Certain project builds don't apply the publish plugin directly (be it the legacy or current one); instead they implement their own 'build plugin' (e.g. within `buildSrc`) that itself then applies plugins. This can lead to the situation where this custom plugin is applied and actioned after the GME tooling plugin which therefore does not detect any publishing plugins. It is possible to list those custom plugins as 'hooks' that GME will detect, and attempt to customise the publishing again. It is a comma separated list with a single default entry of `elasticsearch.esplugin`.

### General Configuration

#### Disabling the Plugins
Expand Down

0 comments on commit bc68db7

Please sign in to comment.