docs.yml

name: Build documentation

on:
  push:
    branches: ['main']

  workflow_dispatch:

env:
  # Name of module and id separated by a slash
  INSTANCE: docs/typed-fastify
  # Replace HI with the ID of the instance in capital letters
  ARTIFACT: webHelpTYPED-FASTIFY2-all.zip

jobs:
  build:
    runs-on: ubuntu-latest
    env:
      EARTHLY_TOKEN: ${{ secrets.EARTHLY_TOKEN }}
      FORCE_COLOR: 1
    environment:
      name: main
    steps:
      - uses: earthly/actions-setup@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          version: 'latest'
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Run build
        run: earthly --org Coobaha --sat docs --ci --output +docs.build
      - name: Run tests
        run: earthly --org Coobaha --sat docs --ci +docs.test

      - name: Upload documentation
        uses: actions/upload-artifact@v3
        with:
          name: docs
          path: |
            artifacts/${{ env.ARTIFACT }}
            artifacts/report.json
          retention-days: 7

  deploy:
    permissions:
      id-token: write
      pages: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    needs: build
    runs-on: ubuntu-latest
    steps:
      - name: Download artifact
        uses: actions/download-artifact@v3
        with:
          name: docs

      - name: Unzip artifact
        uses: montudor/action-zip@v1
        with:
          args: unzip -qq ${{ env.ARTIFACT }} -d dir

      - name: Setup Pages
        uses: actions/configure-pages@v3

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: dir

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2