build-docs.yml

name: Build documentation

on:
    push:
        branches: ["main"]
    workflow_dispatch:

permissions:
    id-token: write
    pages: write

env:
    INSTANCE: "Writerside/sdh"
    ARTIFACT: "webHelpHI2-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: Writerside/sdh
                  artifact: webHelpSDH2-all.zip
                  docker-version: 241.18775

            - name: Save artifact with build results
              uses: actions/upload-artifact@v4
              with:
                  name: docs
                  path: |
                      artifacts/webHelpSDH2-all.zip
                      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: Writerside/sdh

    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 'webHelpSDH2-all.zip' -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