Skip to content

Commit

Permalink
Fix jekyll build checks to match actual deployment, constrain versi…
Browse files Browse the repository at this point in the history
…on (#79)
  • Loading branch information
mkorbel1 authored Jan 6, 2025
1 parent 4ab842c commit de7a312
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 9 deletions.
6 changes: 1 addition & 5 deletions .github/workflows/general.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,4 @@ jobs:
with:
use-quiet-mode: yes # output is too noisy, see https://github.com/gaurav-nelson/github-action-markdown-link-check/issues/121
config-file: .github/configs/mlc_config.json

- uses: PaulRosenthal/Jekyll-Deploy-Test-Action@v3
with:
gemfile-location: '/docs'
site-directory: '/docs'

14 changes: 10 additions & 4 deletions .github/workflows/jekyll.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
# separate terms of service, privacy policy, and support
# documentation.

# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll site to Pages
# Workflow for building and deploying a Jekyll site to GitHub Pages
name: Build and Deploy Jekyll site to Pages

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

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand All @@ -34,9 +36,10 @@ jobs:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Ruby
uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1' # Not needed with a .ruby-version file
ruby-version: '3.1' # Not needed with a .ruby-version file, but putting since the file is range
working-directory: docs
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
cache-version: 0 # Increment this number if you need to re-download cached gems
- name: Setup Pages
Expand All @@ -58,6 +61,9 @@ jobs:

# Deployment job
deploy:
# only deploy when it's merged into the main branch
if: github.event_name == 'push' && github.ref == 'refs/heads/main'

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
Expand Down
1 change: 1 addition & 0 deletions docs/.ruby-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
>= 3.0
2 changes: 2 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
source "https://rubygems.org"

ruby file: ".ruby-version"

gem "jekyll", "~> 4.3.4"
gem "minimal-mistakes-jekyll"

0 comments on commit de7a312

Please sign in to comment.