davisusanibar commented on a change in pull request #12578: URL: https://github.com/apache/arrow/pull/12578#discussion_r821777219
########## File path: docs/source/java/install.rst ########## @@ -83,35 +83,87 @@ Installing Nightly Packages Arrow nightly builds are uploaded to GitHub. For example, for 2022/03/01, they can be found at `Github Nightly`_. -To test your code with these artifacts, then configure Maven with: +Follow the steps and get your nightly packages installed to local maven repository: + +1. Decide nightly packages repository to use, for example: https://github.com/ursacomputing/crossbow/releases/tag/nightly-2022-03-03-0-github-java-jars +2. Define nightly packages to use, for example: `arrow-vector` and `arrow-format` .. code-block:: xml - $ cat ~/.m2/settings.xml - <?xml version="1.0" encoding="UTF-8"?> - <settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd"; xmlns="http://maven.apache.org/SETTINGS/1.1.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";> - <profiles> - <profile> - <repositories> - <repository> - <id>staged</id> - <name>staged-releases</name> - <url>https://github.com/ursacomputing/crossbow/releases/tag/nightly-2022-03-01-0-github-java-jars/</url> - <releases> - <enabled>true</enabled> - </releases> - <snapshots> - <enabled>true</enabled> - </snapshots> - </repository> - </repositories> - <id>arrownightly</id> - </profile> - </profiles> - </settings> - $ mvn -Parrownightly clean install -X - Downloading from staged: https://github.com/ursacomputing/crossbow/releases/tag/nightly-2022-03-01-0-github-java-jars/org/apache/arrow/arrow-vector/8.0.0.dev143/arrow-vector-8.0.0.dev143.pom + <properties> + <maven.compiler.source>8</maven.compiler.source> + <maven.compiler.target>8</maven.compiler.target> + <arrow.version>8.0.0.dev165</arrow.version> + </properties> + + <dependencies> + <dependency> + <groupId>org.apache.arrow</groupId> + <artifactId>arrow-vector</artifactId> + <version>${arrow.version}</version> + </dependency> + <dependency> + <groupId>org.apache.arrow</groupId> + <artifactId>arrow-format</artifactId> + <version>${arrow.version}</version> + </dependency> + </dependencies> + +3. Download packages needed to a temporary directory + +.. code-block:: shell + + $ mkdir nightly-2022-03-03-0-github-java-jars + $ cd nightly-2022-03-03-0-github-java-jars + $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-2022-03-03-0-github-java-jars/arrow-vector-8.0.0.dev165.jar + $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-2022-03-03-0-github-java-jars/arrow-format-8.0.0.dev165.jar + $ tree + |__ arrow-format-8.0.0.dev165.jar + |__ arrow-vector-8.0.0.dev165.jar + +4. Install nightly java version to local maven repository with `mvn install:install-file` + +.. code-block:: shell + + $ mvn install:install-file \ + -Dfile="$(pwd)/arrow-format-8.0.0.dev165.jar" \ + -DgroupId=org.apache.arrow \ + -DartifactId=arrow-format \ + -Dversion=8.0.0.dev165 \ + -Dpackaging=jar \ + -DcreateChecksum=true \ + -Dgenerate.pom=true + [INFO] Installing /nightly-2022-03-03-0-github-java-jars/arrow-format-8.0.0.dev165.jar to /Users/arrow/.m2/repository/org/apache/arrow/arrow-format/8.0.0.dev165/arrow-format-8.0.0.dev165.jar + $ mvn install:install-file \ + -Dfile="$(pwd)/arrow-vector-8.0.0.dev165.jar" \ + -DgroupId=org.apache.arrow \ + -DartifactId=arrow-vector \ + -Dversion=8.0.0.dev165 \ + -Dpackaging=jar \ + -DcreateChecksum=true \ + -Dgenerate.pom=true + [INFO] Installing /nightly-2022-03-03-0-github-java-jars/arrow-vector-8.0.0.dev165.jar to /Users/arrow/.m2/repository/org/apache/arrow/arrow-vector/8.0.0.dev165/arrow-vector-8.0.0.dev165.jar + +6. Validate packages installed locally on maven repository: + +.. code-block:: shell + + $ tree /Users/arrow/.m2/repository/org/apache/arrow + |__ arrow-format + |__ 8.0.0.dev165 + |__ arrow-format-8.0.0.dev165.jar + |__ arrow-format-8.0.0.dev165.pom + |__ arrow-vector + |__ 8.0.0.dev165 + |__ arrow-vector-8.0.0.dev165.jar + |__ arrow-vector-8.0.0.dev165.pom + +5. Compile your project with `mvn clean install`. + +.. code-block:: shell + + $ mvn clean install + [INFO] BUILD SUCCESS Arrow nightly builds are posted on the mailing list at `[email protected]`_. Review comment: Added to the initial part of: Installing Nightly Packages -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
