deploy-gh-pages.yml

name: Deploy (Github pages)

on:
  push:
    branches:
      - main
  workflow_dispatch:
  workflow_run:
    # Only trigger, when the build verification succeeds
    workflows: ["Build verification"]
    types:
      - completed

jobs:
  deploy:
    name: Deploy
    runs-on: ubuntu-latest
    env:
      PAT: ${{ secrets.PAT }}
      ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
      ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}

    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: npm

      - name: Install dependencies
        run: npm ci
      - name: Build website
        run: npm run build

      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./build
          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
          user_name: github-actions[bot]
          user_email: 41898282+github-actions[bot]@users.noreply.github.com

      # TODO: Method not allowed with this API key (not be available for docsearch os free)
      # TODO: Read the README #crawler for more details
      # - name: Algolia docsearch indexer
      #   uses: darrenjennings/algolia-docsearch-action@master
      #   with:
      #     algolia_application_id: ${{env.ALGOLIA_APP_ID}}
      #     algolia_api_key: ${{env.ALGOLIA_API_KEY}}
      #     file: config.docsearch.json