From 8bc6d82554e273a3dc6600280d2e6b9a8c3d735a Mon Sep 17 00:00:00 2001 From: Emilio Date: Wed, 22 Jan 2025 12:14:20 -0500 Subject: [PATCH] Fix build links in README (#3261) --- README.md | 53 +++++++++++++++++++++------------------ build/templates/README.md | 53 +++++++++++++++++++++------------------ 2 files changed, 56 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index b3b300a68ea7..3c621869fbb1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +

@@ -37,9 +38,7 @@ geospatial analytics. ## Downloads -**Current release: [5.2.0](https://github.com/locationtech/geomesa/releases/tag/geomesa-5.2.0)** - -      +**Latest release: [5.2.0](https://github.com/locationtech/geomesa/releases/tag/geomesa-5.2.0)**  -  [**Accumulo**](https://github.com/locationtech/geomesa/releases/download/geomesa-5.2.0/geomesa-accumulo_2.12-5.2.0-bin.tar.gz) | [**HBase**](https://github.com/locationtech/geomesa/releases/download/geomesa-5.2.0/geomesa-hbase_2.12-5.2.0-bin.tar.gz) | [**Cassandra**](https://github.com/locationtech/geomesa/releases/download/geomesa-5.2.0/geomesa-cassandra_2.12-5.2.0-bin.tar.gz) | @@ -54,21 +53,21 @@ Downloads hosted on GitHub include SHA-256 hashes and gpg signatures (.asc files import the appropriate key: ```bash -$ gpg2 --keyserver hkp://pool.sks-keyservers.net --recv-keys CD24F317 +gpg2 --keyserver hkp://pool.sks-keyservers.net --recv-keys CD24F317 ``` Then verify the file: ```bash -$ gpg2 --verify geomesa-accumulo_2.12-5.2.0-bin.tar.gz.asc geomesa-accumulo_2.12-5.2.0-bin.tar.gz +gpg2 --verify geomesa-accumulo_2.12-5.2.0-bin.tar.gz.asc geomesa-accumulo_2.12-5.2.0-bin.tar.gz ``` The keys currently used for signing are: -| Key ID | Name | -| ------ | ---- | +| Key ID | Name | +|------------|----------------------------------------------------| | `CD24F317` | Emilio Lahr-Vivaz <elahrvivaz(-at-)ccri.com> | -| `1E679A56` | James Hughes <jnh5y(-at-)ccri.com> | +| `1E679A56` | James Hughes <jnh5y(-at-)ccri.com> | ## Maven Integration @@ -178,15 +177,8 @@ libraryDependencies ++= Seq( ## Building from Source -**Development version: 5.3.0-SNAPSHOT** - -      - [![Build Status](https://github.com/locationtech/geomesa/actions/workflows/build-and-test-2.12.yml/badge.svg?branch=main)](https://github.com/locationtech/geomesa/actions/workflows/build-and-test-2.12.yml?query=branch%3Amain) - -      - [![Build Status](https://github.com/locationtech/geomesa/actions/workflows/build-and-test-2.13.yml/badge.svg?branch=main)](https://github.com/locationtech/geomesa/actions/workflows/build-and-test-2.13.yml?query=branch%3Amain) - -      +    + [![Build Status](https://github.com/locationtech/geomesa/actions/workflows/main-build.yml/badge.svg?branch=main)](https://github.com/locationtech/geomesa/actions/workflows/main-build.yml?query=branch%3Amain)   [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/locationtech/geomesa/badge)](https://api.securityscorecards.dev/projects/github.com/locationtech/geomesa) Requirements: @@ -198,12 +190,16 @@ Requirements: Use Git to download the source code. Navigate to the destination directory, then run: - git clone git@github.com:locationtech/geomesa.git - cd geomesa +```bash +git clone git@github.com:locationtech/geomesa.git +cd geomesa +``` The project is built using Maven. To build, run: - mvn clean install -DskipTests +```bash +mvn clean install -DskipTests +``` The full build takes quite a while. To speed it up, you may use multiple threads (`-T 1.5C`). @@ -214,7 +210,9 @@ To run unit tests, omit the `-DskipTests` (note: requires `docker` to be availab GeoMesa also provides experimental support for the [Bloop](https://scalacenter.github.io/bloop/) compile server, which provides fast incremental compilation. To export the GeoMesa build to Bloop, run: - ./build/scripts/bloop-export.sh +```bash +./build/scripts/bloop-export.sh +``` For more information on using Bloop, refer to the [Bloop documentation](https://scalacenter.github.io/bloop/docs/build-tools/maven). @@ -226,18 +224,23 @@ which provides fast incremental compilation. However, please note that Zinc is n To use an existing Zinc server, run maven with `-Pzinc`. GeoMesa provides a helper script at `build/mvn`, which is a wrapper around Maven that downloads and runs Zinc automatically: - build/mvn clean install -T8 -DskipTests +```bash +build/mvn clean install -T8 -DskipTests +``` If the Zinc build fails with an error finding "javac", try setting the JAVA_HOME environment variable to point to the root of your JDK. Example from a Mac: - JAVA_HOME="/Library/Java/JavaVirtualMachines/jdk1.8.0_51.jdk/Contents/Home" build/mvn clean install - +```bash +JAVA_HOME="/Library/Java/JavaVirtualMachines/jdk1.8.0_51.jdk/Contents/Home" build/mvn clean install +``` ### Scala Cross Build To build for a different Scala version (e.g. 2.13), run the following script, then build as normal: - ./build/scripts/change-scala-version.sh 2.13 +```bash +./build/scripts/change-scala-version.sh 2.13 +``` ### Building on OS X diff --git a/build/templates/README.md b/build/templates/README.md index ac1244bdf07b..d5cbdeb468e3 100644 --- a/build/templates/README.md +++ b/build/templates/README.md @@ -1,3 +1,4 @@ +

@@ -37,9 +38,7 @@ geospatial analytics. ## Downloads -**Current release: [${geomesa.release.version}](https://github.com/locationtech/geomesa/releases/tag/geomesa-${geomesa.release.version})** - -      +**Latest release: [${geomesa.release.version}](https://github.com/locationtech/geomesa/releases/tag/geomesa-${geomesa.release.version})**  -  [**Accumulo**](https://github.com/locationtech/geomesa/releases/download/geomesa-${geomesa.release.version}/geomesa-accumulo_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz) | [**HBase**](https://github.com/locationtech/geomesa/releases/download/geomesa-${geomesa.release.version}/geomesa-hbase_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz) | [**Cassandra**](https://github.com/locationtech/geomesa/releases/download/geomesa-${geomesa.release.version}/geomesa-cassandra_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz) | @@ -54,21 +53,21 @@ Downloads hosted on GitHub include SHA-256 hashes and gpg signatures (.asc files import the appropriate key: ```bash -$ gpg2 --keyserver hkp://pool.sks-keyservers.net --recv-keys CD24F317 +gpg2 --keyserver hkp://pool.sks-keyservers.net --recv-keys CD24F317 ``` Then verify the file: ```bash -$ gpg2 --verify geomesa-accumulo_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz.asc geomesa-accumulo_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz +gpg2 --verify geomesa-accumulo_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz.asc geomesa-accumulo_${scala.binary.version}-${geomesa.release.version}-bin.tar.gz ``` The keys currently used for signing are: -| Key ID | Name | -| ------ | ---- | +| Key ID | Name | +|------------|----------------------------------------------------| | `CD24F317` | Emilio Lahr-Vivaz <elahrvivaz(-at-)ccri.com> | -| `1E679A56` | James Hughes <jnh5y(-at-)ccri.com> | +| `1E679A56` | James Hughes <jnh5y(-at-)ccri.com> | ## Maven Integration @@ -178,15 +177,8 @@ libraryDependencies ++= Seq( ## Building from Source -**Development version: ${geomesa.devel.version}** - -      - [![Build Status](https://github.com/locationtech/geomesa/actions/workflows/build-and-test-2.12.yml/badge.svg?branch=main)](https://github.com/locationtech/geomesa/actions/workflows/build-and-test-2.12.yml?query=branch%3Amain) - -      - [![Build Status](https://github.com/locationtech/geomesa/actions/workflows/build-and-test-2.13.yml/badge.svg?branch=main)](https://github.com/locationtech/geomesa/actions/workflows/build-and-test-2.13.yml?query=branch%3Amain) - -      +    + [![Build Status](https://github.com/locationtech/geomesa/actions/workflows/main-build.yml/badge.svg?branch=main)](https://github.com/locationtech/geomesa/actions/workflows/main-build.yml?query=branch%3Amain)   [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/locationtech/geomesa/badge)](https://api.securityscorecards.dev/projects/github.com/locationtech/geomesa) Requirements: @@ -198,12 +190,16 @@ Requirements: Use Git to download the source code. Navigate to the destination directory, then run: - git clone git@github.com:locationtech/geomesa.git - cd geomesa +```bash +git clone git@github.com:locationtech/geomesa.git +cd geomesa +``` The project is built using Maven. To build, run: - mvn clean install -DskipTests +```bash +mvn clean install -DskipTests +``` The full build takes quite a while. To speed it up, you may use multiple threads (`-T 1.5C`). @@ -214,7 +210,9 @@ To run unit tests, omit the `-DskipTests` (note: requires `docker` to be availab GeoMesa also provides experimental support for the [Bloop](https://scalacenter.github.io/bloop/) compile server, which provides fast incremental compilation. To export the GeoMesa build to Bloop, run: - ./build/scripts/bloop-export.sh +```bash +./build/scripts/bloop-export.sh +``` For more information on using Bloop, refer to the [Bloop documentation](https://scalacenter.github.io/bloop/docs/build-tools/maven). @@ -226,18 +224,23 @@ which provides fast incremental compilation. However, please note that Zinc is n To use an existing Zinc server, run maven with `-Pzinc`. GeoMesa provides a helper script at `build/mvn`, which is a wrapper around Maven that downloads and runs Zinc automatically: - build/mvn clean install -T8 -DskipTests +```bash +build/mvn clean install -T8 -DskipTests +``` If the Zinc build fails with an error finding "javac", try setting the JAVA_HOME environment variable to point to the root of your JDK. Example from a Mac: - JAVA_HOME="/Library/Java/JavaVirtualMachines/jdk1.8.0_51.jdk/Contents/Home" build/mvn clean install - +```bash +JAVA_HOME="/Library/Java/JavaVirtualMachines/jdk1.8.0_51.jdk/Contents/Home" build/mvn clean install +``` ### Scala Cross Build To build for a different Scala version (e.g. 2.13), run the following script, then build as normal: - ./build/scripts/change-scala-version.sh 2.13 +```bash +./build/scripts/change-scala-version.sh 2.13 +``` ### Building on OS X