From 37c57a7dc6663bf6140137d5c488dfe810d80dd7 Mon Sep 17 00:00:00 2001 From: Vladimir Vagaytsev Date: Thu, 22 Jun 2023 16:58:25 +0200 Subject: [PATCH] docs(jib): show current Maven Daemon version in docs --- docs/reference/action-types/Build/jib-container.md | 4 ++++ docs/reference/module-types/jib-container.md | 4 ++++ plugins/jib/index.ts | 4 +++- plugins/jib/mavend.ts | 2 +- 4 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/reference/action-types/Build/jib-container.md b/docs/reference/action-types/Build/jib-container.md index 41711a5d66..fb70cabd1f 100644 --- a/docs/reference/action-types/Build/jib-container.md +++ b/docs/reference/action-types/Build/jib-container.md @@ -263,6 +263,8 @@ spec: # Defines the location of the custom executable Maven Daemon binary. # + # If not provided, then Maven Daemon 0.9.0 will be downloaded and used. + # # **Note!** Either `jdkVersion` or `jdkPath` will be used to define `JAVA_HOME` environment variable for the custom # Maven Daemon. # To ensure a system JDK usage, please set `jdkPath` to `${local.env.JAVA_HOME}`. @@ -722,6 +724,8 @@ Defines the Maven phases to be executed during the Garden build step. Defines the location of the custom executable Maven Daemon binary. +If not provided, then Maven Daemon 0.9.0 will be downloaded and used. + **Note!** Either `jdkVersion` or `jdkPath` will be used to define `JAVA_HOME` environment variable for the custom Maven Daemon. To ensure a system JDK usage, please set `jdkPath` to `${local.env.JAVA_HOME}`. diff --git a/docs/reference/module-types/jib-container.md b/docs/reference/module-types/jib-container.md index 94d65a12b7..8643c9cf4b 100644 --- a/docs/reference/module-types/jib-container.md +++ b/docs/reference/module-types/jib-container.md @@ -114,6 +114,8 @@ build: # Defines the location of the custom executable Maven Daemon binary. # + # If not provided, then Maven Daemon 0.9.0 will be downloaded and used. + # # **Note!** Either `jdkVersion` or `jdkPath` will be used to define `JAVA_HOME` environment variable for the custom # Maven Daemon. # To ensure a system JDK usage, please set `jdkPath` to `${local.env.JAVA_HOME}`. @@ -1018,6 +1020,8 @@ Defines the Maven phases to be executed during the Garden build step. Defines the location of the custom executable Maven Daemon binary. +If not provided, then Maven Daemon 0.9.0 will be downloaded and used. + **Note!** Either `jdkVersion` or `jdkPath` will be used to define `JAVA_HOME` environment variable for the custom Maven Daemon. To ensure a system JDK usage, please set `jdkPath` to `${local.env.JAVA_HOME}`. diff --git a/plugins/jib/index.ts b/plugins/jib/index.ts index 2fcdc8b76b..5644ad734b 100644 --- a/plugins/jib/index.ts +++ b/plugins/jib/index.ts @@ -12,7 +12,7 @@ import { dedent } from "@garden-io/sdk/util/string" import { openJdkSpecs } from "./openjdk" import { mavenSpec, mvn, mvnVersion } from "./maven" -import { mavendSpec, mvnd } from "./mavend" +import { mavendSpec, mvnd, mvndVersion } from "./mavend" import { gradle, gradleSpec, gradleVersion } from "./gradle" // TODO: gradually get rid of these core dependencies, move some to SDK etc. @@ -116,6 +116,8 @@ const jibBuildSchemaKeys = () => ({ mavendPath: joi.string().optional().description(dedent` Defines the location of the custom executable Maven Daemon binary. + If not provided, then Maven Daemon ${mvndVersion} will be downloaded and used. + **Note!** Either \`jdkVersion\` or \`jdkPath\` will be used to define \`JAVA_HOME\` environment variable for the custom Maven Daemon. To ensure a system JDK usage, please set \`jdkPath\` to \`${systemJdkGardenEnvVar}\`. `), diff --git a/plugins/jib/mavend.ts b/plugins/jib/mavend.ts index b1996caf34..72dec52ce6 100644 --- a/plugins/jib/mavend.ts +++ b/plugins/jib/mavend.ts @@ -14,7 +14,7 @@ import { BuildToolParams, runBuildTool, verifyBinaryPath, VerifyBinaryParams } f const buildLock = new AsyncLock() -const mvndVersion = "0.9.0" +export const mvndVersion = "0.9.0" const mvndSpec = { description: "The Maven Daemon CLI.",