This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This workflow uses actions that are not certified by GitHub. | |
# They are provided by a third-party and are governed by | |
# separate terms of service, privacy policy, and support | |
# documentation. | |
# Workflow to build and deploy a Jekyll site to GitHub Pages | |
name: Deploy Jekyll site to Pages | |
on: | |
# Trigger workflow on pushes to the main branch | |
push: | |
branches: ["main"] | |
# Allow manual workflow triggers | |
workflow_dispatch: | |
# Permissions for GitHub Pages deployment | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Concurrency settings to prevent overlapping runs | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
# Job to build the Jekyll site | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
# Step 1: Checkout repository code | |
- name: Checkout | |
uses: actions/checkout@v4 | |
# Step 2: Set up Ruby environment | |
- name: Setup Ruby | |
uses: ruby/setup-ruby@v1 | |
with: | |
ruby-version: '3.1' # Adjust to match your local Ruby version | |
bundler-cache: true # Automatically runs 'bundle install' and caches gems | |
# Step 3: Set up GitHub Pages | |
- name: Setup Pages | |
id: pages | |
uses: actions/configure-pages@v5 | |
# Step 4: Build the Jekyll site | |
- name: Build with Jekyll | |
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" | |
env: | |
JEKYLL_ENV: production | |
# Step 5: Upload the built site as an artifact | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
# Job to deploy the built site | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
# Step 6: Deploy the site to GitHub Pages | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |