docsearch-scraper.yaml

name: TypeSense DocSearch Scraper

# This workflow updates the search index on TypeSense every time the main branch changes

on:
  workflow_dispatch:

  schedule:
    # * is a special character in YAML so we have to quote this string
    - cron: "21 7 * * *"

  workflow_run:
    workflows: ["FreeSWITCH Docs"]
    types:
      - completed

jobs:
  scraper:
    runs-on: ubuntu-latest
    name: Run docs site scraper

    steps:
      - name: Check out the repo
        uses: actions/checkout@v4

      - name: Run scraper
        shell: bash
        run: |
          docker run --rm --name ts-scraper -v "${{ github.workspace }}:/tmp/search" \
            -e "TYPESENSE_API_KEY=${{ secrets.TYPESENSE_API_KEY }}" \
            -e "TYPESENSE_HOST=typesense.signalwire.cloud" \
            -e "TYPESENSE_PORT=443" \
            -e "TYPESENSE_PROTOCOL=https" \
            -e "CONFIG=/tmp/search/typesense.json" \
            typesense/docsearch-scraper:0.9.1