Skip to content

Commit

Permalink
docs: add info about convenience maven project (#2407)
Browse files Browse the repository at this point in the history
* docs: add info about convenience maven project
  • Loading branch information
zmiklank committed Jan 21, 2022
1 parent 12d4a22 commit 3d60938
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/documentation/head/setup.md
Expand Up @@ -27,7 +27,7 @@ Precompiled versions of the driver can be downloaded from the [PostgreSQL™ JDB
Alternatively you can build the driver from source, but you should only need to
do this if you are making changes to the source code. To build the JDBC driver,
you need gradle and a JDK (currently at least jdk1.8) .

If you have several Java compilers installed, maven will use the first one on the path.
To use a different one set JAVA_HOME to the Java version you wish to use For example,
to use a different JDK than the default, this may work:
Expand All @@ -42,3 +42,14 @@ Where MM is the major version, nn is the minor version and pp is the patch versi
Versions for JDBC3 and lower can be found [here](https://jdbc.postgresql.org/download.html#others)
This is a very brief outline of how to build the driver. Much more detailed information can be
found on the [github repo](https://github.com/pgjdbc/pgjdbc/blob/master/CONTRIBUTING.md)

Even though the JDBC driver should be built with Gradle, for situations, where use of Gradle is not possible,
e.g., when building pgjdbc for distributions, the pgjdbc Gradle build provides a convenience
source release artifact `*-src.tar.gz` - a Maven based project.
The Maven based project contains a version of the JDBC driver with complete functionality,
which can be used in production and is still validly buildable within the Maven build environment.
The Maven-based project is created with **gradlew -d :postgresql:sourceDistribution -Prelease**.
The produced `*-src.tar.gz` can be then found in `pgjdbc/build/distributions/` directory.
JDBC driver can be built from the Maven-based project with **mvn package** or,
when the tests are to be skipped, with **mvn -DskipTests package**.
Prefactored `*-src.tar.gz`s are released in the [Maven central repository](https://repo1.maven.org/maven2/org/postgresql/postgresql/).

0 comments on commit 3d60938

Please sign in to comment.