This is an automated email from the ASF dual-hosted git repository.
adutra pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new 5fbbc43d Admin tool: change root package and create binary
distributions (#748)
5fbbc43d is described below
commit 5fbbc43dd422ad4bba55d99b2969d86ed449ae7d
Author: Alexandre Dutra <[email protected]>
AuthorDate: Wed Jan 15 10:45:00 2025 +0100
Admin tool: change root package and create binary distributions (#748)
---
quarkus/admin/README.md | 21 ++++++++++++++++++++-
quarkus/admin/build.gradle.kts | 15 +++++++++++++++
.../quarkus/admin => admintool}/BaseCommand.java | 2 +-
.../admin => admintool}/BootstrapCommand.java | 2 +-
.../admin => admintool}/PolarisAdminTool.java | 2 +-
.../admin => admintool}/PolarisVersionProvider.java | 2 +-
.../quarkus/admin => admintool}/PurgeCommand.java | 2 +-
.../admin => admintool}/BootstrapCommandTest.java | 2 +-
.../admin => admintool}/PurgeCommandTest.java | 2 +-
9 files changed, 42 insertions(+), 8 deletions(-)
diff --git a/quarkus/admin/README.md b/quarkus/admin/README.md
index 1058f91f..1499dc95 100644
--- a/quarkus/admin/README.md
+++ b/quarkus/admin/README.md
@@ -4,7 +4,26 @@ This module contains a maintenance tool for performing
administrative tasks on t
It is a Quarkus application that can be used to perform various maintenance
tasks targeting the
Polaris database directly.
-Building this module will create a runnable uber-jar that can be executed from
the command line.
+## Archive distribution
+
+Building this module will create a zip/tar distribution with the Polaris
server.
+
+To build the distribution, you can use the following command:
+
+```shell
+./gradlew :polaris-quarkus-admin:build
+```
+
+You can manually unpack and run the distribution archives:
+
+```shell
+cd quarkus/admin/build/distributions
+unzip polaris-quarkus-admin-<version>.zip
+cd polaris-quarkus-admin-<version>
+java -jar polaris-quarkus-admin-<version>-runner.jar
+```
+
+## Docker image
To also build the Docker image, you can use the following command:
diff --git a/quarkus/admin/build.gradle.kts b/quarkus/admin/build.gradle.kts
index fc813333..145340c7 100644
--- a/quarkus/admin/build.gradle.kts
+++ b/quarkus/admin/build.gradle.kts
@@ -25,6 +25,7 @@ plugins {
alias(libs.plugins.openapi.generator)
id("polaris-server")
id("polaris-license-report")
+ id("distribution")
}
dependencies {
@@ -84,3 +85,17 @@ tasks.named("sourcesJar") {
dependsOn("compileQuarkusGeneratedSourcesJava") }
tasks.named("javadoc") { dependsOn("jandex") }
tasks.named("quarkusDependenciesBuild") { dependsOn("jandex") }
+
+tasks.named("distZip") { dependsOn("quarkusBuild") }
+
+tasks.named("distTar") { dependsOn("quarkusBuild") }
+
+distributions {
+ main {
+ contents {
+ from("../../NOTICE")
+ from("../../LICENSE-BINARY-DIST").rename("LICENSE-BINARY-DIST",
"LICENSE")
+ from(project.layout.buildDirectory) {
include("polaris-quarkus-admin-*-runner.jar") }
+ }
+ }
+}
diff --git
a/quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/BaseCommand.java
b/quarkus/admin/src/main/java/org/apache/polaris/admintool/BaseCommand.java
similarity index 97%
rename from
quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/BaseCommand.java
rename to
quarkus/admin/src/main/java/org/apache/polaris/admintool/BaseCommand.java
index 6b690c76..f478e03f 100644
---
a/quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/BaseCommand.java
+++ b/quarkus/admin/src/main/java/org/apache/polaris/admintool/BaseCommand.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.polaris.service.quarkus.admin;
+package org.apache.polaris.admintool;
import jakarta.inject.Inject;
import java.util.concurrent.Callable;
diff --git
a/quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/BootstrapCommand.java
b/quarkus/admin/src/main/java/org/apache/polaris/admintool/BootstrapCommand.java
similarity index 98%
rename from
quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/BootstrapCommand.java
rename to
quarkus/admin/src/main/java/org/apache/polaris/admintool/BootstrapCommand.java
index 5d9f5bec..22a2e8ac 100644
---
a/quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/BootstrapCommand.java
+++
b/quarkus/admin/src/main/java/org/apache/polaris/admintool/BootstrapCommand.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.polaris.service.quarkus.admin;
+package org.apache.polaris.admintool;
import java.util.List;
import java.util.Map;
diff --git
a/quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/PolarisAdminTool.java
b/quarkus/admin/src/main/java/org/apache/polaris/admintool/PolarisAdminTool.java
similarity index 97%
rename from
quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/PolarisAdminTool.java
rename to
quarkus/admin/src/main/java/org/apache/polaris/admintool/PolarisAdminTool.java
index 3b332735..8b678f6c 100644
---
a/quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/PolarisAdminTool.java
+++
b/quarkus/admin/src/main/java/org/apache/polaris/admintool/PolarisAdminTool.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.polaris.service.quarkus.admin;
+package org.apache.polaris.admintool;
import io.quarkus.picocli.runtime.annotations.TopCommand;
import java.io.PrintWriter;
diff --git
a/quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/PolarisVersionProvider.java
b/quarkus/admin/src/main/java/org/apache/polaris/admintool/PolarisVersionProvider.java
similarity index 95%
rename from
quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/PolarisVersionProvider.java
rename to
quarkus/admin/src/main/java/org/apache/polaris/admintool/PolarisVersionProvider.java
index 8c252113..6682a5d6 100644
---
a/quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/PolarisVersionProvider.java
+++
b/quarkus/admin/src/main/java/org/apache/polaris/admintool/PolarisVersionProvider.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.polaris.service.quarkus.admin;
+package org.apache.polaris.admintool;
import org.apache.polaris.version.PolarisVersion;
import picocli.CommandLine.IVersionProvider;
diff --git
a/quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/PurgeCommand.java
b/quarkus/admin/src/main/java/org/apache/polaris/admintool/PurgeCommand.java
similarity index 96%
rename from
quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/PurgeCommand.java
rename to
quarkus/admin/src/main/java/org/apache/polaris/admintool/PurgeCommand.java
index 63963c12..e28d0efa 100644
---
a/quarkus/admin/src/main/java/org/apache/polaris/service/quarkus/admin/PurgeCommand.java
+++ b/quarkus/admin/src/main/java/org/apache/polaris/admintool/PurgeCommand.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.polaris.service.quarkus.admin;
+package org.apache.polaris.admintool;
import java.util.List;
import picocli.CommandLine;
diff --git
a/quarkus/admin/src/test/java/org/apache/polaris/service/quarkus/admin/BootstrapCommandTest.java
b/quarkus/admin/src/test/java/org/apache/polaris/admintool/BootstrapCommandTest.java
similarity index 96%
rename from
quarkus/admin/src/test/java/org/apache/polaris/service/quarkus/admin/BootstrapCommandTest.java
rename to
quarkus/admin/src/test/java/org/apache/polaris/admintool/BootstrapCommandTest.java
index 0e964c07..cf290823 100644
---
a/quarkus/admin/src/test/java/org/apache/polaris/service/quarkus/admin/BootstrapCommandTest.java
+++
b/quarkus/admin/src/test/java/org/apache/polaris/admintool/BootstrapCommandTest.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.polaris.service.quarkus.admin;
+package org.apache.polaris.admintool;
import static org.assertj.core.api.Assertions.assertThat;
diff --git
a/quarkus/admin/src/test/java/org/apache/polaris/service/quarkus/admin/PurgeCommandTest.java
b/quarkus/admin/src/test/java/org/apache/polaris/admintool/PurgeCommandTest.java
similarity index 96%
rename from
quarkus/admin/src/test/java/org/apache/polaris/service/quarkus/admin/PurgeCommandTest.java
rename to
quarkus/admin/src/test/java/org/apache/polaris/admintool/PurgeCommandTest.java
index 902cf8a1..efcbc8f8 100644
---
a/quarkus/admin/src/test/java/org/apache/polaris/service/quarkus/admin/PurgeCommandTest.java
+++
b/quarkus/admin/src/test/java/org/apache/polaris/admintool/PurgeCommandTest.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.polaris.service.quarkus.admin;
+package org.apache.polaris.admintool;
import static org.assertj.core.api.Assertions.assertThat;
