feat(pace-172): update docs with runtimes and upload artifacts to releases (#208)

* docs(pace-172): add runtimes section

* fix(pace-172): incorrect path to new docs section

* feat(pace-172): upload jar artifacts to release

Author: trietsch

.github/workflows/publish-release-artifacts.yaml

@@ -52,13 +52,23 @@ jobs:
         run: |
           make copy-json-schema-to-resources
 
-      # JVM artifact
+      # JVM artifacts
       - uses: actions/setup-java@v4
         with:
           distribution: temurin
-          java-version: 17
+          java-version: 21
       - uses: gradle/actions/setup-gradle@v3
-      - run: ./gradlew prepareForDocker -PciBuild -PgeneratedBufDependencyVersion=${{ env.BUF_DEPENDENCY_VERSION }}
+      - run: ./gradlew build prepareForDocker -PciBuild -PgeneratedBufDependencyVersion=${{ env.BUF_DEPENDENCY_VERSION }}
+      - name: Upload
+        env:
+          GITHUB_TOKEN: ${{secrets.GH_TOKEN}}
+        run: |
+          tag_name="${GITHUB_REF##*/}"
+          mkdir artifacts
+          find . -type d -name "libs" -not -path "./core/*" -not -path "./build/*" | xargs -I{} find "{}" -type f -name "*.jar" | xargs -I{} sh -c 'cp "{}" "./artifacts/$(echo {} | cut -d / -f 2).jar"'
+          gh release upload  "$tag_name" $(find artifacts -type f -name "*.jar" -printf "%p ")
+
+      # Build container image
       - name: "Generate Proto Filedescriptor"
         # Normally generated in the Gradle prepareForDocker step, but the ciBuild flag disables that
         run: |

docs/SUMMARY.md

@@ -45,6 +45,10 @@
     * [PostgreSQL](global-actions/global-transforms/processing-platform-tags/postgresql.md)
   * [Data Catalog Tags](global-actions/global-transforms/data-catalog-tags.md)
 
+## Runtimes
+
+* [Overview](runtimes/overview.md)
+
 ## Plugins
 
 * [Definition](plugins/definition.md)

docs/runtimes/overview/containerized_dbt_module.md

@@ -0,0 +1,23 @@
+# Running PACE dbt module in a container
+
+The requirements for running PACE dbt module inside a container are:
+* JVM Runtime (Java 17 or later)
+* The PACE dbt module jar file (can be retrieved from the PACE releases on GitHub)
+
+An example of what a Dockerfile could look like is shown below:
+
+```Dockerfile
+FROM eclipse-temurin:21-jre-jammy as jvm
+
+FROM python:slim
+
+RUN mkdir /app
+WORKDIR /app
+
+# Copy the JVM runtime
+COPY --from=jvm /opt/java/openjdk /opt/java/openjdk
+
+# Set the environment variables and add the JVM to the PATH
+ENV JAVA_HOME=/opt/java/openjdk
+ENV PATH="${JAVA_HOME}/bin:${PATH}"
+```

docs/runtimes/overview/overview.md

@@ -0,0 +1,12 @@
+# Runtimes
+
+PACE supports the following runtimes:
+
+* Spring Boot application
+  A continuous running application that is connected to your Data Catalog and Processing Platform.
+  This is meant to be instructed through the API to perform specific actions, such as create a view
+  based on a Data Policy.
+* Standalone dbt module  
+  A module that includes the same core functionality that the Spring Boot application offers, but is
+  meant to be short-lived, within the scope of its task. It is used to extend a dbt project, in
+  order read the `manifest.json` and create Data Policies based on the models in the dbt project.