build-test-docs.yml

name: Build and test documentation

on:
  pull_request:
    paths:
      - 'docs/pages/**'
      - '.github/workflows/**'
  workflow_dispatch:
  workflow_call:

permissions:
  id-token: write
  pages: write

env:
  INSTANCE: 'kotlinx-rpc/rpc'
  ARTIFACT: 'webHelpRPC2-all.zip'
  DOCKER_VERSION: '241.15989'

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 }}
          locations: docs/pages/kotlinx-rpc/

      - name: Save artifact with build results
        uses: actions/upload-artifact@v4
        with:
          name: kotlinx-rpc
          path: |
            artifacts/${{ env.ARTIFACT }}
            artifacts/report.json
            artifacts/${{ env.ALGOLIA_ARTIFACT }}
          retention-days: 7

  test:
    needs: build
    runs-on: ubuntu-latest
    steps:
      - name: Download artifacts
        uses: actions/download-artifact@v4
        with:
          name: kotlinx-rpc
          path: artifacts

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