Skip to content

Commit b199469

Browse files
committed
ci(gh-pages): Update Jekyll build and Ruby setup for GH Pages
1 parent 2a96ded commit b199469

File tree

4 files changed

+118
-15
lines changed

4 files changed

+118
-15
lines changed

.github/workflows/jekyll-gh-pages.yml

+24-14
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,53 @@
1-
name: Github Page
1+
name: GitHub Pages
22

33
on:
4-
# Runs on pushes targeting the default branch
54
push:
65
branches: ["main"]
7-
8-
# Allows you to run this workflow manually from the Actions tab
96
workflow_dispatch:
107

11-
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
128
permissions:
139
contents: read
1410
pages: write
1511
id-token: write
1612

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

2317
jobs:
24-
# Build job
2518
build:
2619
runs-on: ubuntu-latest
2720
steps:
2821
- name: Checkout
2922
uses: actions/checkout@v4
23+
24+
- name: Setup Ruby
25+
uses: ruby/setup-ruby@v1
26+
with:
27+
ruby-version: '3.2'
28+
bundler-cache: true
29+
3030
- name: Setup Pages
31+
id: pages
3132
uses: actions/configure-pages@v5
32-
- name: Build with Jekyll
33-
uses: actions/jekyll-build-pages@v1
34-
with:
35-
source: ./docs
36-
destination: ./_site
33+
34+
- name: Install dependencies
35+
run: |
36+
cd docs
37+
bundle install
38+
39+
- name: Build site
40+
run: |
41+
cd docs
42+
bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
43+
env:
44+
JEKYLL_ENV: production
45+
3746
- name: Upload artifact
3847
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: docs/_site
3950

40-
# Deployment job
4151
deploy:
4252
environment:
4353
name: github-pages

docs/.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
_site/
2+
.sass-cache/
3+
.jekyll-cache/
4+
.jekyll-metadata
5+
.bundle/
6+
vendor/

docs/Gemfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ source "https://rubygems.org"
22

33
gem "jekyll", "~> 4.3.2"
44
gem "just-the-docs", "~> 0.5.3"
5+
gem "webrick", "~> 1.8" # Required for Ruby 3+
56

6-
# If you have any plugins, put them here!
77
group :jekyll_plugins do
88
gem "jekyll-feed", "~> 0.17.0"
99
gem "jekyll-seo-tag", "~> 2.8.0"

docs/Gemfile.lock

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.7)
5+
public_suffix (>= 2.0.2, < 7.0)
6+
colorator (1.1.0)
7+
concurrent-ruby (1.3.5)
8+
em-websocket (0.5.3)
9+
eventmachine (>= 0.12.9)
10+
http_parser.rb (~> 0)
11+
eventmachine (1.2.7)
12+
ffi (1.17.1)
13+
forwardable-extended (2.6.0)
14+
http_parser.rb (0.8.0)
15+
i18n (1.14.7)
16+
concurrent-ruby (~> 1.0)
17+
jekyll (4.3.4)
18+
addressable (~> 2.4)
19+
colorator (~> 1.0)
20+
em-websocket (~> 0.5)
21+
i18n (~> 1.0)
22+
jekyll-sass-converter (>= 2.0, < 4.0)
23+
jekyll-watch (~> 2.0)
24+
kramdown (~> 2.3, >= 2.3.1)
25+
kramdown-parser-gfm (~> 1.0)
26+
liquid (~> 4.0)
27+
mercenary (>= 0.3.6, < 0.5)
28+
pathutil (~> 0.9)
29+
rouge (>= 3.0, < 5.0)
30+
safe_yaml (~> 1.0)
31+
terminal-table (>= 1.8, < 4.0)
32+
webrick (~> 1.7)
33+
jekyll-feed (0.17.0)
34+
jekyll (>= 3.7, < 5.0)
35+
jekyll-sass-converter (2.2.0)
36+
sassc (> 2.0.1, < 3.0)
37+
jekyll-seo-tag (2.8.0)
38+
jekyll (>= 3.8, < 5.0)
39+
jekyll-watch (2.2.1)
40+
listen (~> 3.0)
41+
just-the-docs (0.5.4)
42+
jekyll (>= 3.8.5)
43+
jekyll-seo-tag (>= 2.0)
44+
rake (>= 12.3.1)
45+
kramdown (2.5.1)
46+
rexml (>= 3.3.9)
47+
kramdown-parser-gfm (1.1.0)
48+
kramdown (~> 2.0)
49+
liquid (4.0.4)
50+
listen (3.9.0)
51+
rb-fsevent (~> 0.10, >= 0.10.3)
52+
rb-inotify (~> 0.9, >= 0.9.10)
53+
mercenary (0.4.0)
54+
pathutil (0.16.2)
55+
forwardable-extended (~> 2.6)
56+
public_suffix (5.1.1)
57+
rake (13.2.1)
58+
rb-fsevent (0.11.2)
59+
rb-inotify (0.11.1)
60+
ffi (~> 1.0)
61+
rexml (3.4.1)
62+
rouge (3.30.0)
63+
safe_yaml (1.0.5)
64+
sassc (2.4.0)
65+
ffi (~> 1.9)
66+
terminal-table (3.0.2)
67+
unicode-display_width (>= 1.1.1, < 3)
68+
unicode-display_width (2.6.0)
69+
webrick (1.9.1)
70+
71+
PLATFORMS
72+
ruby
73+
74+
DEPENDENCIES
75+
http_parser.rb (~> 0.6.0)
76+
jekyll (~> 4.3.2)
77+
jekyll-feed (~> 0.17.0)
78+
jekyll-sass-converter (~> 2.2.0)
79+
jekyll-seo-tag (~> 2.8.0)
80+
just-the-docs (~> 0.5.3)
81+
tzinfo (~> 2.0)
82+
tzinfo-data
83+
wdm (~> 0.1.1)
84+
webrick (~> 1.8)
85+
86+
BUNDLED WITH
87+
1.17.2

0 commit comments

Comments
 (0)