deploy-gh-pages.yml

name: 📑 Deploy to GitHub Pages

on:
  push:
    branches:
      - "**" # This will match pushes to any branch
  pull_request:
    types: [opened, synchronize, reopened, closed]
    branches:
      - "**"
  workflow_dispatch:

jobs:
  generate:
    name: Generate and Deploy documentation
    if: >
      github.event_name == 'push' ||
      github.event_name == 'pull_request' ||
      github.event_name == 'workflow_dispatch'
    runs-on: ubuntu-22.04
    steps:
      - name: Git checkout
        uses: actions/checkout@v3 # actions/checkout v3.0.2

      - name: Setup Python 3.9
        uses: actions/setup-python@v4
        with:
          python-version: "3.9"
          architecture: x64

      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.8.1
          virtualenvs-create: true
          virtualenvs-in-project: true

      - name: Setup sudo apt installs for ubuntu-latest
        run: |
          sudo apt-get update
          sudo apt-get install -y \
              libgtk-3-dev \
              libwebkit2gtk-4.0-dev

      - name: Download OpenBB Platform code
        run: |
          curl -sSL https://codeload.github.com/OpenBB-finance/OpenBB/zip/refs/heads/main -o /tmp/openbb.zip && \
              unzip /tmp/openbb.zip -d /tmp/openbb && \
              rm /tmp/openbb.zip && mkdir -p ./openbb_platform && \
              mv /tmp/openbb/OpenBB-main/openbb_platform/* ./openbb_platform && \
              rm -rf /tmp/openbb

      - name: Generate Platform Markdown
        run: |
          poetry install -C openbb_platform --only-root --no-interaction
          source openbb_platform/.venv/bin/activate
          pip install -U poetry
          python openbb_platform/dev_install.py --extras
          python -c "import openbb; openbb.build()"
          python scripts/generate_platform_markdown.py

      - name: Generate Excel Docs
        run: |
          pip install requests
          python scripts/generate_excel_markdown.py

      - name: Generate Widgets Library
        run: |
          pip install requests
          python scripts/generate_widgets_library.py

      - name: Setup Node
        uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: yarn
          cache-dependency-path: yarn.lock

      - name: Install dependencies
        run: yarn install

      - name: Build website
        run: yarn build

      # Popular action to deploy to GitHub Pages:
      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        if: >
          (startsWith(github.ref, 'refs/heads/main')) ||
          (github.event_name == 'pull_request' &&
          github.event.pull_request.merged == true &&
          github.event.pull_request.base.ref == 'main')
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./build
          # The following lines assign commit authorship to the official
          # GH-Actions bot for deploys to `gh-pages` branch:
          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
          # The GH actions bot is used by default if you didn't specify the two fields.
          # You can swap them out with your own user credentials.
          user_name: github-actions[bot]
          user_email: 41898282+github-actions[bot]@users.noreply.github.com