deploy.yml

name: Deploy to Pages

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

  # 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: write
  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:
  # Build job
  build:
    runs-on: ubuntu-latest
    if: ${{ github.repository != 'kevinschaul/jump-start-template' }}
    env:
      GITHUB_USERNAME: ${{ github.repository_owner }}
      GITHUB_REPO: ${{ github.event.repository.name }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Dotenv
        id: dotenv
        uses: falti/dotenv-action@v1.1.2
        with:
          keys-case: bypass

      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: "20"
          cache: npm

      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v5

      - name: Install dependencies
        run: |
          npm run setup

      - name: Update readme
        run: |
          npm run update-readme

      - name: Commit and push
        run: |
          git config user.name github-actions
          git config user.email github-actions@github.com
          git add -A
          timestamp=$(date -u)
          git commit -m "chore: update readme at ${timestamp}" || exit 0
          git push

      - name: Set up Python
        if: ${{ steps.dotenv.outputs.DEPLOY_CUSTOM_SITE == 'true' }}
        uses: actions/setup-python@v5
        with:
          python-version: '3.10'

      - uses: actions/cache@v4
        if: ${{ steps.dotenv.outputs.DEPLOY_CUSTOM_SITE == 'true' }}
        name: Configure pip caching
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
          restore-keys: |
            ${{ runner.os }}-pip-

      - name: Cache Playwright browsers
        if: ${{ steps.dotenv.outputs.DEPLOY_CUSTOM_SITE == 'true' }}
        uses: actions/cache@v4
        with:
          path: ~/.cache/ms-playwright/
          key: ${{ runner.os }}-browsers

      - name: Install Python dependencies
        if: ${{ steps.dotenv.outputs.DEPLOY_CUSTOM_SITE == 'true' }}
        run: |
          pip install -r jump-start-gallery/requirements.txt

      - name: Install Playwright dependencies
        if: ${{ steps.dotenv.outputs.DEPLOY_CUSTOM_SITE == 'true' }}
        run: |
          shot-scraper install

      - name: Start server and take screenshots
        if: ${{ steps.dotenv.outputs.DEPLOY_CUSTOM_SITE == 'true' }}
        run: |
          mkdir -p jump-start-gallery/public/screenshots &&
          npm run dev &
          sleep 2 &&
          npm run update-screenshots

      - name: Build custom site
        if: ${{ steps.dotenv.outputs.DEPLOY_CUSTOM_SITE == 'true' }}
        env:
          GITHUB_PAGES_BASE_PATH: ${{ steps.pages.outputs.base_path }}
        run: npm run build

      - name: Upload custom site artifact
        if: ${{ steps.dotenv.outputs.DEPLOY_CUSTOM_SITE == 'true' }}
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./jump-start-gallery/dist

      - name: Build storybook
        if: ${{ steps.dotenv.outputs.DEPLOY_STORYBOOK == 'true' }}
        env:
          GITHUB_PAGES_BASE_PATH: ${{ steps.pages.outputs.base_path }}
        run: npm run build-storybook

      - name: Upload custom site artifact
        if: ${{ steps.dotenv.outputs.DEPLOY_STORYBOOK == 'true' }}
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./jump-start-gallery/storybook-static

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    if: ${{ github.repository != 'kevinschaul/jump-start-template' }}
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4