aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorLéo Kosman <leo.kosman@proton.me>2024-08-24 22:58:35 +0200
committerLéo Kosman <leo.kosman@proton.me>2024-08-24 22:58:35 +0200
commit275604ac67e4fa3b20035f3756add1701e879c13 (patch)
tree0aa50872cec5bd834061e7f48c17117ff4c53ed9 /.github
parent06027e9cd2b71a9606fb38dbde261cc629a68cc1 (diff)
parentf9702feda784bfe7fef3cb8b8d0ddb420010ea5b (diff)
Merge branch 'refs/heads/main' into feat/world-borders
# Conflicts: # src/main/java/world/anhgelus/molehunt/game/Game.java
Diffstat (limited to '.github')
-rw-r--r--.github/workflows/build-docs.yml80
1 files changed, 80 insertions, 0 deletions
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
new file mode 100644
index 0000000..84f9cb0
--- /dev/null
+++ b/.github/workflows/build-docs.yml
@@ -0,0 +1,80 @@
+name: Build documentation
+
+on:
+ push:
+ branches: ["main"]
+ workflow_dispatch:
+
+permissions:
+ id-token: write
+ pages: write
+
+env:
+ INSTANCE: 'Writerside/md'
+ ARTIFACT: 'webHelpMD2-all.zip'
+ DOCKER_VERSION: '241.18775'
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+
+ - name: Build docs using Writerside Docker builder
+ uses: JetBrains/writerside-github-action@v4
+ with:
+ instance: ${{ env.INSTANCE }}
+ artifact: ${{ env.ARTIFACT }}
+ docker-version: ${{ env.DOCKER_VERSION }}
+
+ - name: Save artifact with build results
+ uses: actions/upload-artifact@v4
+ with:
+ name: docs
+ path: |
+ artifacts/${{ env.ARTIFACT }}
+ artifacts/report.json
+ retention-days: 7
+ test:
+ needs: build
+ runs-on: ubuntu-latest
+ steps:
+ - name: Download artifacts
+ uses: actions/download-artifact@v4
+ with:
+ name: docs
+ path: artifacts
+
+ - name: Test documentation
+ uses: JetBrains/writerside-checker-action@v1
+ with:
+ instance: ${{ env.INSTANCE }}
+ deploy:
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ needs: [build, test]
+ runs-on: ubuntu-latest
+ steps:
+ - name: Download artifacts
+ uses: actions/download-artifact@v4
+ with:
+ name: docs
+
+ - name: Unzip artifact
+ run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir
+
+ - name: Setup Pages
+ uses: actions/configure-pages@v4
+
+ - name: Package and upload Pages artifact
+ uses: actions/upload-pages-artifact@v3
+ with:
+ path: dir
+
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v4