main.yml

name: Build documentation

on:
# If specified, the workflow will be triggered automatically once you push to the `main` branch.
# Replace `main` with your branch’s name
    push:
        branches: ["master"]

# Specify to run a workflow manually from the Actions tab on GitHub
    workflow_dispatch:

env:
    # Name of module and id separated by a slash
    INSTANCE: Writerside/hi
    # Replace HI with the ID of the instance in capital letters
    ARTIFACT: webHelpHI2-all.zip
    # Writerside docker image version
    DOCKER_VERSION: 232.10275

jobs:
    build:
        runs-on: ubuntu-latest
        steps:
            - name: Checkout repository
              uses: actions/checkout@v3

            - name: Build Writerside docs using Docker
              uses: JetBrains/writerside-github-action@v4
              with:
                instance: ${{ env.INSTANCE }}
                artifact: ${{ env.ARTIFACT }}
                docker-version: ${{ env.DOCKER_VERSION }}

            - name: Upload documentation
              uses: actions/upload-artifact@v3
              with:
                name: docs
                path: |
                    artifacts/${{ env.ARTIFACT }}
                    artifacts/report.json
                retention-days: 7
# Add the job below and artifacts/report.json on Upload documentation step above if you want to fail the build when documentation contains errors
    test:
    # Requires building job results
        needs: build
        runs-on: ubuntu-latest

        steps:
            - name: Download artifacts
              uses: actions/download-artifact@v1
              with:
                name: docs
                path: artifacts

            - name: Test documentation
              uses: JetBrains/writerside-checker-action@v1
              with:
                instance: ${{ env.INSTANCE }}