From d3d3618a96170c5fc4d89e0b39f34ee08d37a018 Mon Sep 17 00:00:00 2001 From: Rohan Kumar Date: Fri, 5 Nov 2021 14:44:19 +0530 Subject: [PATCH] RunImageConfiguration: `@Deprecate` `entrypoint` parameter field Right now parameter field for ENTRYPOINT seems to be inconsistent across BuildImageConfiguration and RunImageConfiguration. Use `entryPoint` as parameter in all places and deprecate others: - `@Deprecate` `entrypoint` parameter field - Use `entryPoint` parameter field Signed-off-by: Rohan Kumar --- doc/changelog.md | 3 +++ src/main/asciidoc/inc/misc/_startup.adoc | 14 +++++++------- .../docker/config/RunImageConfiguration.java | 18 ++++++++++++++++-- 3 files changed, 26 insertions(+), 9 deletions(-) diff --git a/doc/changelog.md b/doc/changelog.md index 15037619e..eb2f6bc5c 100644 --- a/doc/changelog.md +++ b/doc/changelog.md @@ -4,6 +4,9 @@ - Allow replacement in tags. Added a new replacement `%T` which always adds a timestamp. ([#1491](https://github.com/fabric8io/docker-maven-plugin/pull/1491)) - Only push the `latest` tag if no other tags where specified in docker mode. This can break your build, if you rely on the automatic `latest` tag. ([#1496](https://github.com/fabric8io/docker-maven-plugin/pull/1496)) - Only push the `latest` tag if no other tags where specified in jib mode. This can break your build, if you rely on the automatic `latest` tag. ([#1498](https://github.com/fabric8io/docker-maven-plugin/pull/1498)) + - Deprecate `entrypoint` parameter in `` configuration ([1488](https://github.com/fabric8io/docker-maven-plugin/pull/1488)) + +**Note:** `entrypoint` parameter in `` configuration is marked as deprecated. Users are advised to use `entryPoint` parameter instead. * **0.37.0** (2021-08-15) - Fix stop mojo by taking container name pattern into account (#1168) diff --git a/src/main/asciidoc/inc/misc/_startup.adoc b/src/main/asciidoc/inc/misc/_startup.adoc index ecde111a2..a27e63593 100644 --- a/src/main/asciidoc/inc/misc/_startup.adoc +++ b/src/main/asciidoc/inc/misc/_startup.adoc @@ -29,10 +29,10 @@ Either shell or params should be specified. .Example [source,xml] ---- - + java -jar $HOME/server.jar - + ---- or @@ -40,14 +40,14 @@ or .Example [source,xml] ---- - + java -jar /opt/demo/server.jar - + ---- This can be formulated also more dense with: @@ -56,7 +56,7 @@ This can be formulated also more dense with: [source,xml] ---- -java -jar $HOME/server.jar +java -jar $HOME/server.jar ---- or @@ -64,11 +64,11 @@ or .Example [source,xml] ---- - + java -jar /opt/demo/server.jar - + ---- diff --git a/src/main/java/io/fabric8/maven/docker/config/RunImageConfiguration.java b/src/main/java/io/fabric8/maven/docker/config/RunImageConfiguration.java index 2311d3a72..f7a55f6ad 100644 --- a/src/main/java/io/fabric8/maven/docker/config/RunImageConfiguration.java +++ b/src/main/java/io/fabric8/maven/docker/config/RunImageConfiguration.java @@ -47,10 +47,17 @@ public boolean isDefault() { @Parameter private List dependsOn; - // container entry point + /** + * container entry point + * @deprecated This field would be removed in upcoming releases. Use entryPoint instead. + */ @Parameter + @Deprecated private Arguments entrypoint; + @Parameter + private Arguments entryPoint; + // container hostname @Parameter private String hostname; @@ -201,6 +208,9 @@ public String initAndValidate() { if (entrypoint != null) { entrypoint.validate(); } + if (entryPoint != null) { + entryPoint.validate(); + } if (cmd != null) { cmd.validate(); } @@ -227,7 +237,10 @@ public String getEnvPropertyFile() { } public Arguments getEntrypoint() { - return entrypoint; + if (entrypoint != null) { + return entrypoint; + } + return entryPoint; } public String getHostname() { @@ -478,6 +491,7 @@ public Builder domainname(String domainname) { public Builder entrypoint(Arguments args) { config.entrypoint = args; + config.entryPoint = args; return this; }