Refactor Maven Runner build config #2911
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| package org.jetbrains.conventions | ||
|
|
||
| import org.gradle.kotlin.dsl.support.serviceOf | ||
|
|
||
| /** | ||
| * Utility for downloading and installing a Maven binary. | ||
| */ | ||
|
|
||
| plugins { | ||
| base | ||
| } | ||
|
|
||
| abstract class SetupMavenProperties { | ||
| val mavenVersion = "3.5.0" | ||
| val mavenPluginToolsVersion = "3.5.2" | ||
| abstract val mavenBuildDir: DirectoryProperty | ||
| abstract val mavenBinDir: DirectoryProperty | ||
| abstract val mvn: RegularFileProperty | ||
| } | ||
|
|
||
| val setupMavenProperties = | ||
| extensions.create("setupMavenProperties", SetupMavenProperties::class).apply { | ||
| mavenBuildDir.set(layout.buildDirectory.dir("maven")) | ||
| mavenBinDir.set(layout.buildDirectory.dir("maven-bin")) | ||
| mvn.set(mavenBinDir.map { it.file("apache-maven-$mavenVersion/bin/mvn") }) | ||
| } | ||
|
|
||
| val mavenBinary by configurations.registering { | ||
| description = "used to download the Maven binary" | ||
| isCanBeResolved = true | ||
| isCanBeConsumed = false | ||
| isVisible = false | ||
|
|
||
| defaultDependencies { | ||
| add( | ||
| project.dependencies.create( | ||
| group = "org.apache.maven", | ||
| name = "apache-maven", | ||
| version = setupMavenProperties.mavenVersion, | ||
| classifier = "bin", | ||
| ext = "zip" | ||
| ) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| tasks.clean { | ||
| delete(setupMavenProperties.mavenBuildDir) | ||
| delete(setupMavenProperties.mavenBinDir) | ||
| } | ||
|
|
||
| val installMavenBinary by tasks.registering(Sync::class) { | ||
| val archives = serviceOf<ArchiveOperations>() | ||
| from( | ||
| mavenBinary.flatMap { conf -> | ||
| conf.incoming.artifacts.resolvedArtifacts.map { artifacts -> | ||
| artifacts.map { archives.zipTree(it.file) } | ||
| } | ||
| } | ||
| ) | ||
| into(setupMavenProperties.mavenBinDir) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,95 +1,101 @@ | ||
| import org.gradle.kotlin.dsl.support.appendReproducibleNewLine | ||
| import org.jetbrains.CrossPlatformExec | ||
| import org.jetbrains.registerDokkaArtifactPublication | ||
|
|
||
| plugins { | ||
| org.jetbrains.conventions.`kotlin-jvm` | ||
| org.jetbrains.conventions.`maven-publish` | ||
| org.jetbrains.conventions.`maven-cli-setup` | ||
| } | ||
|
|
||
| dependencies { | ||
| implementation(project(":core")) | ||
| implementation("org.apache.maven:maven-core:${setupMavenProperties.mavenVersion}") | ||
| implementation("org.apache.maven:maven-plugin-api:${setupMavenProperties.mavenVersion}") | ||
| implementation("org.apache.maven.plugin-tools:maven-plugin-annotations:${setupMavenProperties.mavenPluginToolsVersion}") | ||
| implementation("org.apache.maven:maven-archiver:2.5") | ||
| implementation(kotlin("stdlib-jdk8")) | ||
| } | ||
|
|
||
| val mavenPluginTaskGroup = "maven plugin" | ||
|
|
||
| val generatePom by tasks.registering(Sync::class) { | ||
| description = "Generate pom.xml for Maven Plugin Plugin" | ||
| group = mavenPluginTaskGroup | ||
|
|
||
| val dokka_version: String by project | ||
| inputs.property("dokka_version", dokka_version) | ||
|
|
||
| val pomTemplateFile = layout.projectDirectory.file("pom.tpl.xml") | ||
aSemy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| from(pomTemplateFile) { | ||
| rename { it.replace(".tpl.xml", ".xml") } | ||
|
|
||
| expand( | ||
| "mavenVersion" to setupMavenProperties.mavenVersion, | ||
| "dokka_version" to dokka_version, | ||
| "mavenPluginToolsVersion" to setupMavenProperties.mavenPluginToolsVersion, | ||
| ) | ||
|
There was a problem hiding this comment. using the Gradle To achieve this, I needed to update the properties in |
||
| } | ||
|
|
||
| into(temporaryDir) | ||
|
There was a problem hiding this comment. Instead of worrying about Sync/Copy tasks overwriting, and having to use |
||
| } | ||
|
|
||
| val prepareMavenPluginBuildDir by tasks.registering(Sync::class) { | ||
| description = "Prepares all files for Maven Plugin task execution" | ||
| group = mavenPluginTaskGroup | ||
|
|
||
| from(tasks.compileKotlin.flatMap { it.destinationDirectory }) { into("classes/java/main") } | ||
| from(tasks.compileJava.flatMap { it.destinationDirectory }) { into("classes/java/main") } | ||
|
|
||
| from(generatePom) | ||
|
|
||
| into(setupMavenProperties.mavenBuildDir) | ||
| } | ||
|
|
||
| val helpMojo by tasks.registering(CrossPlatformExec::class) { | ||
| group = mavenPluginTaskGroup | ||
|
|
||
| dependsOn(tasks.installMavenBinary, prepareMavenPluginBuildDir) | ||
| workingDir(setupMavenProperties.mavenBuildDir) | ||
| executable(setupMavenProperties.mvn.get()) | ||
| args("-e", "-B", "org.apache.maven.plugins:maven-plugin-plugin:helpmojo") | ||
|
|
||
| outputs.dir(setupMavenProperties.mavenBuildDir) | ||
|
|
||
| doLast("normalize maven-plugin-help.properties") { | ||
| // The maven-plugin-help.properties file contains a timestamp by default. | ||
| // It should be removed as it is not reproducible and impacts Gradle caching | ||
| val pluginHelpProperties = workingDir.resolve("maven-plugin-help.properties") | ||
| pluginHelpProperties.writeText( | ||
| buildString { | ||
| val lines = pluginHelpProperties.readText().lines().iterator() | ||
| // the first line is a descriptive comment | ||
| appendReproducibleNewLine(lines.next()) | ||
| // the second line is the timestamp, which should be ignored | ||
| lines.next() | ||
| // the remaining lines are properties | ||
| lines.forEach { appendReproducibleNewLine(it) } | ||
| } | ||
| ) | ||
| } | ||
|
There was a problem hiding this comment. Unfortunately the generated I wrote this code to fix it - but maybe there's a Maven flag that will disable the timestamp? This is perhaps a bit OTT/pre-optimising. There was a problem hiding this comment. I actually don't understand what helpMojo is supposed to achieve, and I can't google anything sensible. It looks like it should either generate the Nothing looks broken to me, so I think it's fine to ignore the timestamp. Perhaps, at some point our Maven plugin should be revisited as well 😅 There was a problem hiding this comment. I think it auto generates a 'help' command based on the properties in the Maven plugin The file it generates is in But, like you, I'm not sure! I've never developed a Maven plugin. package org.jetbrains.dokka.maven;
/**
* Display help information on dokka-maven-plugin.<br>
* Call <code>mvn dokka:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.
* @author maven-plugin-tools
* @goal help
* @requiresProject false
* @threadSafe
*/
public class HelpMojo
extends AbstractMojo
{
/**
* If <code>true</code>, display all settable properties for each goal.
*
* @parameter property="detail" default-value="false"
*/
private boolean detail;
/**
* The name of the goal for which to show help. If unspecified, all goals will be displayed.
*
* @parameter property="goal"
*/
private java.lang.String goal;
/**
* The maximum length of a display line, should be positive.
*
* @parameter property="lineLength" default-value="80"
*/
private int lineLength;
...I was looking at other options, and I found this Gradle plugin: https://github.com/britter/maven-plugin-development. It might help with developing a Maven plugin, but on the other hand, the current approach seems to be working. |
||
| } | ||
|
|
||
| val pluginDescriptor by tasks.registering(CrossPlatformExec::class) { | ||
| group = mavenPluginTaskGroup | ||
|
|
||
| dependsOn(tasks.installMavenBinary, prepareMavenPluginBuildDir) | ||
| workingDir(setupMavenProperties.mavenBuildDir) | ||
| executable(setupMavenProperties.mvn.get()) | ||
| args("-e", "-B", "org.apache.maven.plugins:maven-plugin-plugin:descriptor") | ||
|
|
||
| outputs.dir(layout.buildDirectory.dir("maven/classes/java/main/META-INF/maven")) | ||
| } | ||
|
|
||
| tasks.jar { | ||
| dependsOn(pluginDescriptor, helpMojo) | ||
| metaInf { | ||
| from(setupMavenProperties.mavenBuildDir.map { it.dir("classes/java/main/META-INF") }) | ||
| } | ||
| manifest { | ||
| attributes("Class-Path" to configurations.runtimeClasspath.map { configuration -> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very much optional, while we're at it: I think we actually forget to check/update the Maven version because it's buried in a place we don't visit that much. Extracting it to
gradle.properties(or into thetomlin the other PR) would not hurtThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, I think so too. For now I'll put it in
gradle.properties, and I think that later they can be moved tolibs.versions.tomlas part of #2884There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was a little more work than I thought to refactor this, but I think it was worth it.
It revealed that the
CrossPlatformExectask wasn't really needed, and could be replaced with a Provider that would determine the current operating system and usemvn.cmdon Windows, else usemvn.Hopefully the GitHub Workflow tests pass 🤞
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oof, sorry for asking you to do that then, and thanks for doing! I do think it was worth it though!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no apology needed :)