deploy_docs.yml

name: Build, Test, and Deploy Documentation

on:
  push:
    branches: ['main'] # Trigger workflow on push to the 'main' branch
  workflow_dispatch: # Allow manual triggering of the workflow

env:
  INSTANCE: 'Writerside/dcs' # Name of the module (adjust for your project)
  ARTIFACT: 'webHelpDCS2-all.zip' # Name of the artifact to be generated
  DOCKER_VERSION: '242.21870' # Specific Docker version

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }} # Ensure access to private repo
          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: List files in artifacts directory
        run: ls -R artifacts # List the contents of the artifacts directory

      - name: Save artifact with build results
        uses: actions/upload-artifact@v4
        with:
          name: docs
          path: |
            artifacts/${{ env.ARTIFACT }}
            artifacts/report.json  # Assuming there is a report generated as part of the build
          retention-days: 7 # Keep artifacts for 7 days

  deploy:
    runs-on: ubuntu-latest
    needs: build

    steps:
      - name: List downloaded files
        run: ls -R artifacts # Optional: Debug the downloaded files

      - name: Download artifact
        uses: actions/download-artifact@v4
        with:
          name: artifacts/${{ env.ARTIFACT }} # Download the artifact uploaded in the build step

      - name: Unzip artifact
        run: unzip -O UTF-8 -qq artifacts/${{ env.ARTIFACT }} -d dir

      - name: Configure GitHub Pages
        uses: actions/configure-pages@v4

      - name: Upload artifact to GitHub Pages
        uses: actions/upload-pages-artifact@v3
        with:
          path: dir

      - name: Deploy to GitHub Pages
        uses: actions/deploy-pages@v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }} # Use GITHUB_TOKEN for deployment

  test:
    runs-on: ubuntu-latest
    needs: build # Ensure build completes before running tests

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

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