From 1e9e3844d210c0a1e5eec7f068831ae7dc7135d5 Mon Sep 17 00:00:00 2001 From: Robert Stupp Date: Tue, 8 Apr 2025 16:42:18 +0200 Subject: [PATCH] Remove unnecessary `clean` and `--no-build-cache` from Gradle invocations `quarkusAppPartsBuild --rerun` is the right way to force a Docker image build. --- .github/workflows/helm.yml | 6 +++++- .github/workflows/regtest.yml | 5 ++++- README.md | 9 +++++++-- getting-started/eclipselink/README.md | 9 ++++++--- getting-started/spark/README.md | 5 ++++- getting-started/telemetry/README.md | 5 ++++- getting-started/trino/README.md | 5 ++++- helm/polaris/README.md | 9 ++++++--- helm/polaris/README.md.gotmpl | 9 ++++++--- quarkus/admin/README.md | 5 ++++- quarkus/server/README.md | 13 +++++++++---- regtests/README.md | 5 ++++- run.sh | 8 +++++--- site/content/in-dev/unreleased/admin-tool.md | 7 ++++--- site/content/in-dev/unreleased/metastores.md | 10 ++++++++-- site/content/in-dev/unreleased/quickstart.md | 9 +++++++-- 16 files changed, 87 insertions(+), 32 deletions(-) diff --git a/.github/workflows/helm.yml b/.github/workflows/helm.yml index fd9500d518..b8458e80fc 100644 --- a/.github/workflows/helm.yml +++ b/.github/workflows/helm.yml @@ -99,7 +99,11 @@ jobs: if: steps.list-changed.outputs.changed == 'true' run: | eval $(minikube -p minikube docker-env) - ./gradlew :polaris-quarkus-server:assemble :polaris-quarkus-admin:assemble \ + ./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + :polaris-quarkus-admin:assemble \ + :polaris-quarkus-admin:quarkusAppPartsBuild --rerun \ -Dquarkus.container-image.build=true \ -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4 minikube image ls diff --git a/.github/workflows/regtest.yml b/.github/workflows/regtest.yml index c75da2d9b0..c814a93665 100644 --- a/.github/workflows/regtest.yml +++ b/.github/workflows/regtest.yml @@ -45,7 +45,10 @@ jobs: - name: Image build run: | - ./gradlew :polaris-quarkus-server:assemble -Dquarkus.container-image.build=true + ./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + -Dquarkus.container-image.build=true - name: Regression Test env: diff --git a/README.md b/README.md index 89db1463aa..8204addeee 100644 --- a/README.md +++ b/README.md @@ -76,8 +76,13 @@ select * from db1.table1; #### Running in Docker -- `./gradlew clean :polaris-quarkus-server:assemble -Dquarkus.container-image.build=true --no-build-cache` - To - build the image locally. +- To build the image locally: + ```bash + ./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + -Dquarkus.container-image.build=true + ``` - `docker run -p 8181:8181 -p 8182:8182 apache/polaris:latest` - To run the image. The Polaris codebase contains some docker compose examples to quickly get started with Polaris, diff --git a/getting-started/eclipselink/README.md b/getting-started/eclipselink/README.md index 53618b415a..dd6abf7c29 100644 --- a/getting-started/eclipselink/README.md +++ b/getting-started/eclipselink/README.md @@ -25,11 +25,14 @@ This example requires `jq` to be installed on your machine. the Postgres JDBC driver: ```shell - ./gradlew clean :polaris-quarkus-server:assemble :polaris-quarkus-admin:assemble \ + ./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + :polaris-quarkus-admin:assemble \ + :polaris-quarkus-admin:quarkusAppPartsBuild --rerun \ -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4 \ -Dquarkus.container-image.tag=postgres-latest \ - -Dquarkus.container-image.build=true \ - --no-build-cache + -Dquarkus.container-image.build=true ``` 2. Start the docker compose group by running the following command from the root of the repository: diff --git a/getting-started/spark/README.md b/getting-started/spark/README.md index b523956125..4332d8850b 100644 --- a/getting-started/spark/README.md +++ b/getting-started/spark/README.md @@ -27,7 +27,10 @@ A Jupyter notebook is used to run PySpark. If a Polaris image is not already present locally, build one with the following command: ```shell -./gradlew clean :polaris-quarkus-server:assemble -Dquarkus.container-image.build=true --no-build-cache +./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + -Dquarkus.container-image.build=true ``` ## Run the `docker-compose` file diff --git a/getting-started/telemetry/README.md b/getting-started/telemetry/README.md index 9e07f0ca64..6add2ae9ac 100644 --- a/getting-started/telemetry/README.md +++ b/getting-started/telemetry/README.md @@ -24,7 +24,10 @@ This example requires `jq` to be installed on your machine. 1. Build the Polaris image if it's not already present locally: ```shell - ./gradlew clean :polaris-quarkus-server:assemble -Dquarkus.container-image.build=true --no-build-cache + ./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + -Dquarkus.container-image.build=true ``` 2. Start the docker compose group by running the following command from the root of the repository: diff --git a/getting-started/trino/README.md b/getting-started/trino/README.md index ec1f4ecd11..6b6acf1ef4 100644 --- a/getting-started/trino/README.md +++ b/getting-started/trino/README.md @@ -24,7 +24,10 @@ This getting started guide provides a `docker-compose` file to set up [Trino](ht ## Build Polaris Image Build Polaris Image while Docker is running ``` -./gradlew clean :polaris-quarkus-server:assemble -Dquarkus.container-image.build=true --no-build-cache +./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + -Dquarkus.container-image.build=true ``` ## Run the `docker-compose` file diff --git a/helm/polaris/README.md b/helm/polaris/README.md index 586a991078..e82ec79af8 100644 --- a/helm/polaris/README.md +++ b/helm/polaris/README.md @@ -86,10 +86,13 @@ If necessary, build and load the Docker images with support for Postgres into Mi ```bash eval $(minikube -p minikube docker-env) -./gradlew clean :polaris-quarkus-server:assemble :polaris-quarkus-admin:assemble \ +./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + :polaris-quarkus-admin:assemble \ + :polaris-quarkus-admin:quarkusAppPartsBuild --rerun \ -Dquarkus.container-image.build=true \ - -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4 \ - --no-build-cache + -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4 ``` ### Installing the chart locally diff --git a/helm/polaris/README.md.gotmpl b/helm/polaris/README.md.gotmpl index a41a3cfc2a..18291a1e3e 100644 --- a/helm/polaris/README.md.gotmpl +++ b/helm/polaris/README.md.gotmpl @@ -87,10 +87,13 @@ If necessary, build and load the Docker images with support for Postgres into Mi ```bash eval $(minikube -p minikube docker-env) -./gradlew clean :polaris-quarkus-server:assemble :polaris-quarkus-admin:assemble \ +./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + :polaris-quarkus-admin:assemble \ + :polaris-quarkus-admin:quarkusAppPartsBuild --rerun \ -Dquarkus.container-image.build=true \ - -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4 \ - --no-build-cache + -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4 ``` ### Installing the chart locally diff --git a/quarkus/admin/README.md b/quarkus/admin/README.md index f52d9e8354..d9c966f19b 100644 --- a/quarkus/admin/README.md +++ b/quarkus/admin/README.md @@ -47,7 +47,10 @@ java -jar polaris-quarkus-admin--runner.jar To also build the Docker image, you can use the following command: ```shell -./gradlew clean :polaris-quarkus-admin:assemble -Dquarkus.container-image.build=true --no-build-cache +./gradlew \ + :polaris-quarkus-admin:assemble \ + :polaris-quarkus-admin:quarkusAppPartsBuild --rerun \ + -Dquarkus.container-image.build=true ``` ## Running the Admin Tool diff --git a/quarkus/server/README.md b/quarkus/server/README.md index 9921f47bee..3b2f4e2307 100644 --- a/quarkus/server/README.md +++ b/quarkus/server/README.md @@ -46,16 +46,21 @@ To also build the Docker image, you can use the following command (a running Doc required): ```shell -./gradlew clean :polaris-quarkus-server:assemble -Dquarkus.container-image.build=true --no-build-cache +./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + -Dquarkus.container-image.build=true ``` If you need to customize the Docker image, for example to push to a local registry, you can use the following command: ```shell -./gradlew clean :polaris-quarkus-server:build -Dquarkus.container-image.build=true \ +./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + -Dquarkus.container-image.build=true \ -Dquarkus.container-image.registry=localhost:5001 \ -Dquarkus.container-image.group=apache \ - -Dquarkus.container-image.name=polaris-local \ - --no-build-cache + -Dquarkus.container-image.name=polaris-local ``` diff --git a/regtests/README.md b/regtests/README.md index 57991ea02e..ffe1a318e6 100644 --- a/regtests/README.md +++ b/regtests/README.md @@ -39,7 +39,10 @@ Tests can be run with docker-compose using the provided `./regtests/docker-compo follows: ```shell -./gradlew clean :polaris-quarkus-server:assemble -Dquarkus.container-image.build=true --no-build-cache +./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + -Dquarkus.container-image.build=true docker compose -f ./regtests/docker-compose.yml up --build --exit-code-from regtest ``` diff --git a/run.sh b/run.sh index 0ddd649e52..1394e6e66f 100755 --- a/run.sh +++ b/run.sh @@ -52,10 +52,12 @@ sh ./kind-registry.sh # Build and deploy the server image echo "Building polaris image..." -./gradlew clean :polaris-quarkus-server:build $ECLIPSE_LINK_DEPS \ +./gradlew \ + :polaris-quarkus-server:build \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + $ECLIPSE_LINK_DEPS \ -Dquarkus.container-image.build=true \ - -Dquarkus.container-image.registry=localhost:5001 \ - --no-build-cache + -Dquarkus.container-image.registry=localhost:5001 echo "Pushing polaris image..." docker push localhost:5001/apache/polaris diff --git a/site/content/in-dev/unreleased/admin-tool.md b/site/content/in-dev/unreleased/admin-tool.md index 54d2c7155d..77409dd62c 100644 --- a/site/content/in-dev/unreleased/admin-tool.md +++ b/site/content/in-dev/unreleased/admin-tool.md @@ -28,10 +28,11 @@ The tool must be built with the necessary JDBC drivers to access the metastore d example, to build the tool with support for Postgres, run the following: ```shell -./gradlew clean :polaris-quarkus-admin:build \ +./gradlew \ + :polaris-quarkus-admin:assemble \ + :polaris-quarkus-admin:quarkusAppPartsBuild --rerun \ -Dquarkus.container-image.build=true \ - -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4 \ - --no-build-cache + -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4 ``` The above command will generate: diff --git a/site/content/in-dev/unreleased/metastores.md b/site/content/in-dev/unreleased/metastores.md index 1b8e1d32a0..46a33c6276 100644 --- a/site/content/in-dev/unreleased/metastores.md +++ b/site/content/in-dev/unreleased/metastores.md @@ -92,7 +92,10 @@ your H2 configuration using the persistence unit template below: To build Polaris with the necessary H2 dependency and start the Polaris service, run the following: ```shell -./gradlew clean :polaris-quarkus-server:assemble -PeclipseLinkDeps=com.h2database:h2:2.3.232 +./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + -PeclipseLinkDeps=com.h2database:h2:2.3.232 java -Dpolaris.persistence.type=eclipse-link \ -Dpolaris.persistence.eclipselink.configuration-file=/path/to/persistence.xml \ -Dpolaris.persistence.eclipselink.persistence-unit=polaris \ @@ -130,7 +133,10 @@ The following shows a sample configuration for integrating Polaris with Postgres To build Polaris with the necessary Postgres dependency and start the Polaris service, run the following: ```shell -./gradlew clean :polaris-quarkus-server:assemble -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4 +./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4 java -Dpolaris.persistence.type=eclipse-link \ -Dpolaris.persistence.eclipselink.configuration-file=/path/to/persistence.xml \ -Dpolaris.persistence.eclipselink.persistence-unit=polaris \ diff --git a/site/content/in-dev/unreleased/quickstart.md b/site/content/in-dev/unreleased/quickstart.md index 1b45ce91b0..7561ea784a 100644 --- a/site/content/in-dev/unreleased/quickstart.md +++ b/site/content/in-dev/unreleased/quickstart.md @@ -105,7 +105,10 @@ To start using Polaris in Docker, launch Polaris while Docker is running: ```shell cd ~/polaris -./gradlew clean :polaris-quarkus-server:assemble -Dquarkus.container-image.build=true --no-build-cache +./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun \ + -Dquarkus.container-image.build=true docker run -p 8181:8181 -p 8182:8182 apache/polaris:latest ``` @@ -125,7 +128,9 @@ The easiest way to run Polaris locally is to start the Polaris server from the ```shell cd ~/polaris # Build the server -./gradlew clean :polaris-quarkus-server:assemble +./gradlew \ + :polaris-quarkus-server:assemble \ + :polaris-quarkus-server:quarkusAppPartsBuild --rerun # Start the server java -jar quarkus/server/build/quarkus-app/quarkus-run.jar ```