PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2025-09-09 02:09:38 +02:00
Code Issues Releases Wiki Activity

Add BUILD.md

Browse source
This commit is contained in:
Paul Schaub 2025-04-30 15:57:22 +02:00
parent e444fdd6ca
commit 30b5bf2cc6
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 22 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

22
BUILD.md Normal file
View file

@ -0,0 +1,22 @@
<!--
SPDX-FileCopyrightText: 2025 Paul Schaub <info@pgpainless.org>
SPDX-License-Identifier: Apache-2.0
-->
# Build PGPainless
There are a number of different artifacts that can be built from the PGPainless source code:
## `pgpainless-cli/build/libs/pgpainless-cli-X.Y.Z-all.jar`
This is a fat jar, built using the Shadow plugin.
It bundles all necessary dependencies required by the CLI application at runtime.
This artifact will be produced by the `gradle shadowJar` task, which is run as part of the `gradle assemble` task.
## `pgpainless-cli/build/native/nativeCompile/pgpainless-cli`
This is a native image, that can be built using GraalVM which compared to the executable jar file above
offers greatly improved performance by skipping the JVM startup overhead.
To build this image, you need to run `gradle nativeCompile` using a GraalVM-enabled Java SDK.