jekyll-gh-pages.yml

# Workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll with GitHub Pages dependencies preinstalled

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: 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:
  # Build job (github-pages-build)
  build:
    name: Build (github-pages-build gem)
    runs-on: ubuntu-latest
    env:
      PAGES_REPO_NWO: ${{ github.repository }}
      JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      JEKYLL_ENV: production
      NODE_ENV: production
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4
      - name: Setup Ruby Environment
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: "3.3"
          bundler-cache: true # runs 'bundle install' to install and cache gems
      - name: Add a YAML front matter to README.md
        run: |
          ex README.md <<EOF
          1i
          ---
          title: Home
          layout: home
          nav_order: 1
          nav_enabled: false
          permalink: /
          ---
          .
          wq
          EOF
      - name: Build Jekyll Site
        run: bundle exec jekyll build
      - name: Upload artifact for Pages
        uses: actions/upload-pages-artifact@v3

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4