Update release scripts and docs

Author: pomadchin

HOWTORELEASE.txt

@@ -23,22 +23,28 @@ Release Process
                            "<your password>")
 
     The description of the Sonatype publishment process (everything described below is in a java dir: cd PDAL/java):
+        - GitHub Actions is responisble for the release process:
+            - To make a new snapshot release - push commits into the main branch.
+            - To publish a release - publish the github release through UI or push a tag.
         - Publishing snaphots:
+            Versioning:
+              - Release versions are derived from the latest (not lightweight) tag version. Each tag should start with v,
+                i.e. v2.3.0. The snapshot tag happens on commits that follow the tag, and contain git commit hash.
             Snapshot can be published without PGP sign, it is published to a snapshot repo and allows immediate snaphot updates.
             To publish everything in a local repo use command:
-              - ./scripts/publish-local.sh (publishes scala 2.13 version)
-              - ./scripts/publish-local-212.sh (publishes scala 2.12 version)
-              - ./scripts/publish-local-211.sh (publishes scala 2.11 version)
-              - ./scripts/publish-local-native.sh (publishes native dependencies)
+              - ./scripts/publish-local.sh
+              - ./scripts/publish-local-native.sh (publishes native dependencies only)
             To publish everything into sonatype snapshot repo use:
               - ./scripts/publish-all.sh
             Summary:
               - Run ./scripts/publish-all.sh and everything is available in a snaphost repository
         - Publishing releases:
+            Versioning:
+              - Release versions are derived from the latest (not lightweight) tag version. Each tag should start with v,
+                i.e. v2.3.0.
             To publish everything into sonatype snapshot repo (staging repo) use:
-              - ./scripts/publish-all.sh --suffix="" --signed
-               `suffix` defines version suffix (for example `--suffix="-RC1"`)
-               `signed` means that jar would be uploaded into a staging sonatype repo with a PGP sign
+              - ./scripts/publish-all.sh --signed
+               Snapshot version is derived from the latest tag version. Releases can be published on tags (not lightweight) only.
             Staging means a special repository in a pre released condition.
               - Go into staging repos panel: https://oss.sonatype.org/#stagingRepositories (log in using sonatype user / pwd)
               - Filter by package name (pdal in our case) and select staging repo
@@ -50,8 +56,8 @@ Release Process
             Full official guide: http://central.sonatype.org/pages/ossrh-guide.html
             Deploying to sonatype using sbt official doc: http://www.scala-sbt.org/release/docs/Using-Sonatype.html
             Official sonatype guide with pics of (https://oss.sonatype.org/#stagingRepositories) and answers the question what
-            to do after jars were published into a staging repo (in our case after ./scripts/publish-all.sh --suffix="" --signed step)
+            to do after jars were published into a staging repo (in our case after ./scripts/publish-all.sh step)
             Summary:
-              - Run ./scripts/publish-all.sh --suffix="" --signed to publish everything into staging repo
+              - Run ./scripts/publish-all.sh to publish everything into staging repo
               - Go to sonatype panel https://oss.sonatype.org/#stagingRepositories and release the jar
               - Await ~10 minutes to have jars published to maven central

README.md

@@ -19,9 +19,10 @@ resolvers ++= Seq(
   Resolver.sonatypeRepo("snapshots") // for snaphots
 )
 
+// `<latest version>` refers to the version indicated by the badge above
 libraryDependencies ++= Seq(
-  "io.pdal" %% "pdal" % "x.x.x", // core library
-  "io.pdal" %  "pdal-native" % "x.x.x" // jni bindings
+  "io.pdal" %% "pdal" % "<latest version>", // core library
+  "io.pdal" %  "pdal-native" % "<latest version>" // jni bindings
 )
 ```
 
@@ -37,14 +38,15 @@ javaOptions += "-Djava.library.path=/usr/local/lib"
 You can use `pdal-native` dep in case you don't have installed JNI bindings and to avoid steps described above.
 Dependency contains bindings for `x86_64-darwin` and `x86_64-linux`, other versions are not supported yet.
 
-## PDAL-Scala
+## PDAL-Scala (Scala 2.x)
 
 Scala API allows to build pipeline expressions instead of writing a raw JSON.
 
 ```scala
+// `<latest version>` refers to the version indicated by the badge above
 libraryDependencies ++= Seq(
-  "io.pdal" %% "pdal-scala" % "x.x.x", // scala core library
-  "io.pdal" %  "pdal-native" % "x.x.x" // jni bindings
+  "io.pdal" %% "pdal-scala" % "<latest version>", // scala core library
+  "io.pdal" %  "pdal-native" % "<latest version>" // jni bindings
 )
 ```
 
@@ -132,15 +134,13 @@ PDAL_DEPEND_ON_NATIVE=false ./sbt -Djava.library.path=<path>
   set(CMAKE_CXX_FLAGS "-L<path to dynamic libs> -std=c++11")
   ```
 
-## How to release
+## How to release (outdated)
 
 All the instructions related to the local / maven release process are documented in the [HOWTORELEASE.txt](./HOWTORELEASE.txt) file.
 
 For the local publish it is possible to use the following commands:
 
-* `scripts/publish-local.sh` - to publish Scala 2.13 artifacts
-* `scripts/publish-local-212.sh` - to publish Scala 2.12 artifacts
-* `scripts/publish-local-211.sh` - to publish Scala 2.11 artifacts
+* `scripts/publish-local.sh` - to publish Scala artifacts
 * `scripts/publish-local-native.sh` - to compile and publish artifact with native binaries
 
 For the additional information checkout the [HOWTORELEASE.txt](./HOWTORELEASE.txt) file and the [scripts](./scripts) directory.

scripts/crosscompile-linux.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+# Linux
+docker run -it --rm \
+  -v $PWD:/pdal-java \
+  -v $HOME/.ivy2:/root/.ivy2 \
+  -v $HOME/.sbt:/root/.sbt \
+  -v $HOME/.coursier/cache:/root/.cache/coursier \
+ daunnc/pdal-ubuntu:2.3.0 bash -c "cd ./pdal-java; ./sbt native/compile"

scripts/crosscompile-mac.sh

@@ -1,6 +1,3 @@
 #!/usr/bin/env bash
 
-./scripts/publish.sh "$@"
-./scripts/publish-212.sh "$@"
-./scripts/publish-211.sh "$@"
-./scripts/publish-native.sh "$@"
+./scripts/publish.sh && ./scripts/publish-native.sh