chore: publish site with GitHub Action (#252)

* chore: publish site with GitHub Action

* remove IDE settings

* ignore IDE settings

.github/workflows/build.yml

@@ -18,13 +18,9 @@ jobs:
       matrix:
         include:
         - java: 8
-          maven: verify
         - java: 11
-          maven: verify
         - java: 17
-          maven: verify
         - java: 21
-          maven: verify site
     steps:
       - name: Harden Runner
         uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v2.6.0
@@ -46,9 +42,9 @@ jobs:
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
           restore-keys: ${{ runner.os }}-m2
       - name: Build and analyze
-        run: xvfb-run mvn -B ${{ matrix.maven }}
+        run: xvfb-run mvn -B verify
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d # v3.1.4
-        if: matrix.java == '17'
+        if: matrix.java == '21'
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/site.yml

@@ -0,0 +1,54 @@
+name: Publish Site
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423 # v2.6.0
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
+        with:
+          fetch-depth: 0 # disable shallow checkouts
+      - name: Set up Java
+        uses: actions/setup-java@0ab4596768b603586c0de567f2430c30f5b0d2b0 # v3.13.0
+        with:
+          java-version: 21
+          distribution: 'temurin'
+      - name: Cache Maven packages
+        uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+      - name: Generate site
+        run: xvfb-run mvn -B verify site
+      - name: Upload site artifact
+        uses: actions/upload-pages-artifact@a753861a5debcf57bf8b404356158c8e1e33150c # v2.0.0
+        with:
+          # Upload docs directory
+          path: target/site
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@9dbe3824824f8a1377b8e298bafde1a50ede43e5 # v2.0.4

.gitignore

@@ -26,3 +26,12 @@ hs_err_pid*
 
 # macOS artifacts
 .DS_Store
+
+# IntelliJ Idea settings
+.idea
+
+# Eclipse and VSCode settings
+/.project
+/.classpath
+/.vscode/
+/.settings/