Publish javadoc

Author: mrotteveel

.github/workflows/publish-docs.yml

@@ -0,0 +1,56 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
+
+name: Publish javadoc
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+          cache: gradle
+      - name: Validate Gradle wrapper
+        uses: gradle/wrapper-validation-action@55e685c48d84285a5b0418cd094606e199cca3b6
+      - name: Build with Gradle
+        run: ./gradlew javadoc
+      - name: Cleanup Gradle Cache
+        # Remove some files from the Gradle cache, so they aren't cached by GitHub Actions.
+        # Restoring these files from a GitHub Actions cache might cause problems for future builds.
+        run: |
+          rm -f ~/.gradle/caches/modules-2/modules-2.lock
+          rm -f ~/.gradle/caches/modules-2/gc.properties
+          rm -fr ~/.gradle/caches/*/plugin-resolution/
+          find ~/.gradle/caches/ -name "*.lock" -type f -delete
+      - name: build artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: doc-artifacts
+          path: build/docs
+          retention-days: 1
+  publish-pages:
+    runs-on: ubuntu-latest
+    needs: [ build ]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Get docs artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: doc-artifacts
+          path: docs
+      - name: Deploy to GitHub pages
+        uses: JamesIves/github-pages-deploy-action@4
+        with:
+          folder: docs

README.md

@@ -57,7 +57,7 @@ As an alternative, consider using `BigDecimal` with `MathContext.DECIMAL128`,
 Usage
 -----
 
-For full javadoc (of latest tagged build), see https://firebirdsql.github.io/decimal-java/javadoc/
+For full javadoc (of latest build), see https://firebirdsql.github.io/decimal-java/javadoc/
 
 Decoding a 4-byte Decimal32 to a `java.math.BigDecimal`: