tests.yml

# SPDX-FileCopyrightText: 2024 Pablo Portas López <pablo.portas@udc.es>
#
# SPDX-License-Identifier: GPL-3.0-only AND MIT AND Apache-2.0

name: 🔬 Comprobar documentación

on:
  pull_request:
    types: [ "opened" ]
    paths: [ "docs/**" ]
  workflow_dispatch:

permissions:
  contents: read
  id-token: write
  pages: write

env:
  INSTANCE: 'docs/pro'
  DOCKER_VERSION: '243.22562'

jobs:
  construir:
    name: 📦 Construir
    runs-on: ubuntu-latest
    outputs:
      algolia_artifact: ${{ steps.define-ids.outputs.algolia_artifact }}
      artifact: ${{ steps.define-ids.outputs.artifact }}
    steps:
      - name: ⬇️ Checkout repositorio
        # GitHub Actions
        # MIT
        # https://github.com/actions/checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: ✳️ Define instance id and artifacts
        id: define-ids
        run: |
          INSTANCE=${INSTANCE#*/}
          INSTANCE_ID_UPPER=$(echo "$INSTANCE" | tr '[:lower:]' '[:upper:]')
          ARTIFACT="webHelp${INSTANCE_ID_UPPER}2-all.zip"
          ALGOLIA_ARTIFACT="algolia-indexes-${INSTANCE_ID_UPPER}.zip"

          # Print the values
          echo "INSTANCE_ID_UPPER: $INSTANCE_ID_UPPER"
          echo "ARTIFACT: $ARTIFACT"
          echo "ALGOLIA_ARTIFACT: $ALGOLIA_ARTIFACT"

          # Set the environment variables and outputs
          echo "INSTANCE_ID_UPPER=$INSTANCE_ID_UPPER" >> $GITHUB_ENV
          echo "ARTIFACT=$ARTIFACT" >> $GITHUB_ENV
          echo "ALGOLIA_ARTIFACT=$ALGOLIA_ARTIFACT" >> $GITHUB_ENV
          echo "artifact=$ARTIFACT" >> $GITHUB_OUTPUT
          echo "algolia_artifact=$ALGOLIA_ARTIFACT" >> $GITHUB_OUTPUT

      - name: 🏗️ Construir con Writerside usando Docker
        # JetBrains Open Source
        # Apache-2.0
        # https://github.com/JetBrains/writerside-github-action
        uses: JetBrains/writerside-github-action@v4
        with:
          instance: ${{ env.INSTANCE }}
          artifact: ${{ env.ARTIFACT }}
          docker-version: ${{ env.DOCKER_VERSION }}

      - name: ⬆️ Subir artefacto con los resultados de la construcción
        uses: actions/upload-artifact@v4
        # GitHub Actions
        # MIT
        # https://github.com/actions/upload-artifact
        with:
          name: docs
          path: |
            artifacts/${{ env.ARTIFACT }}
            artifacts/report.json
            artifacts/${{ env.ALGOLIA_ARTIFACT }}
          retention-days: 7

  comprobar:
    name: 📊 Comprobar
    needs: construir
    runs-on: ubuntu-latest
    steps:
      - name: ⬇️ Descargar artefactos
        # GitHub Actions
        # MIT
        # https://github.com/actions/download-artifact
        uses: actions/download-artifact@v4
        with:
          name: docs
          path: artifacts

      - name: 📊 Comprobar documentación
        # JetBrains Open Source
        # Apache-2.0
        # https://github.com/JetBrains/writerside-checker-action
        uses: JetBrains/writerside-checker-action@v1
        with:
          instance: ${{ env.INSTANCE }}