build_deploy_docs.yml

# Simple workflow for deploying static content to GitHub Pages generated by Github
# except for added job steps "Copy Static Files" through "Build MkDocs Pages".
name: Deploy static content to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["master"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Setup Pages
        uses: actions/configure-pages@v3
      - name: Copy Static Files
        run: |
          cp -R docs/website site/
      - name: Replace GITHUB token
        # Use different sed delimiter to avoid clashing with forward slash in URL
        run: |
          find docs/ -type f -exec sed -i "s@GITHUB@${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}\/blob\/master@g" {} \;
      - name: Replace WEBSITE token
        # Use different sed delimiter to avoid clashing with forward slash in URL
        run: |
          WEBSITE_URL="https://${GITHUB_REPOSITORY_OWNER}.github.io/automlbenchmark"
          find docs/ -type f -exec sed -i "s@WEBSITE@${WEBSITE_URL}@g" {} \;
          sed -i "s@WEBSITE@${WEBSITE_URL}@g" mkdocs.yml
      - uses: actions/setup-python@v4
        with:
          python-version: '3.11' 
      - name: Install MkDocs
        run: |
           python -m pip install mkdocs-material
      - name: Build MkDocs Pages
        run: |
          mkdocs build --site-dir site/docs
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          # Upload entire repository
          path: './site/'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2