Build with GitHub Actions (Jekyll 4) and add manual preview deployments (Cloudflare Pages)

.github/workflows/deploy.yml

@@ -0,0 +1,53 @@
+name: Build & Deploy Website
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+# do not cancel a running production deployment
+concurrency:
+  group: pages-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build Website
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v7
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.4'
+        bundler-cache: true
+    - name: Build with Jekyll
+      run: bundle exec jekyll build
+      env:
+        JEKYLL_ENV: production
+    - name: Upload Pages artifact
+      if: github.ref == 'refs/heads/master'
+      uses: actions/upload-pages-artifact@v5
+
+  deploy:
+    name: Deploy to GitHub Pages
+    if: github.ref == 'refs/heads/master'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+    - name: Deploy
+      id: deployment
+      uses: actions/deploy-pages@v5

.github/workflows/preview.yml

@@ -0,0 +1,55 @@
+name: Deploy Preview (manual)
+
+# Deploys the selected branch to Cloudflare Pages (https://<branch>.<project>.pages.dev).
+# The preview deployments are protected with Cloudflare Access (login required).
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  CLOUDFLARE_PROJECT: contextmapper-preview
+
+jobs:
+  preview:
+    name: Build & Deploy Preview
+    # master is deployed to contextmapper.org by the "Build & Deploy Website" workflow
+    if: github.ref != 'refs/heads/master'
+    runs-on: ubuntu-latest
+    environment:
+      name: preview
+      url: ${{ steps.deploy.outputs.pages-deployment-alias-url }}
+
+    steps:
+    - uses: actions/checkout@v7
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.4'
+        bundler-cache: true
+    - name: Build with Jekyll
+      run: bundle exec jekyll build
+      env:
+        JEKYLL_ENV: production
+    - name: Create Cloudflare Pages project (if it does not exist yet)
+      run: |
+        if ! npx --yes wrangler@4 pages project list --json | grep -q "\"$CLOUDFLARE_PROJECT\""; then
+          npx --yes wrangler@4 pages project create "$CLOUDFLARE_PROJECT" --production-branch=master
+        fi
+      env:
+        CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+        CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+    - name: Deploy to Cloudflare Pages
+      id: deploy
+      uses: cloudflare/wrangler-action@v4
+      with:
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+        accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+        command: pages deploy _site --project-name=${{ env.CLOUDFLARE_PROJECT }} --branch=${{ github.ref_name }} --commit-hash=${{ github.sha }}
+    - name: Summary
+      run: |
+        echo "### Preview deployed :rocket:" >> $GITHUB_STEP_SUMMARY
+        echo "" >> $GITHUB_STEP_SUMMARY
+        echo "- Branch: ${{ steps.deploy.outputs.pages-deployment-alias-url }}" >> $GITHUB_STEP_SUMMARY
+        echo "- This deployment: ${{ steps.deploy.outputs.deployment-url }}" >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -1,12 +1,11 @@
 _site
 .sass-cache
 .jekyll-metadata
+.jekyll-cache
 *.gem
 .bundle
 vendor/bundle
 
-Gemfile.lock
-
 # IDEs
 .idea
 *.iml

Gemfile

@@ -1,17 +1,16 @@
 source "https://rubygems.org"
-ruby RUBY_VERSION
 
-# to use GitHub Pages
-gem "github-pages", group: :jekyll_plugins
+gem "jekyll", "~> 4.4"
 
-# If you have any plugins, put them here!
 group :jekyll_plugins do
-   gem "jekyll-feed"
-   gem "jekyll-sitemap"
-   gem "jekyll-redirect-from"
-   gem "jekyll-seo-tag"
-   gem "webrick"
+  gem "jekyll-feed"
+  gem "jekyll-sitemap"
+  gem "jekyll-redirect-from"
+  gem "jekyll-seo-tag"
 end
 
+# needed for "jekyll serve" with Ruby 3
+gem "webrick"
+
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+gem "tzinfo-data", platforms: [:windows, :jruby]

Gemfile.lock

@@ -0,0 +1,178 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    base64 (0.3.0)
+    bigdecimal (4.1.3)
+    colorator (1.1.0)
+    concurrent-ruby (1.3.8)
+    csv (3.3.6)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.17.4)
+    ffi (1.17.4-aarch64-linux-gnu)
+    ffi (1.17.4-aarch64-linux-musl)
+    ffi (1.17.4-arm-linux-gnu)
+    ffi (1.17.4-arm-linux-musl)
+    ffi (1.17.4-arm64-darwin)
+    ffi (1.17.4-x86-linux-gnu)
+    ffi (1.17.4-x86-linux-musl)
+    ffi (1.17.4-x86_64-darwin)
+    ffi (1.17.4-x86_64-linux-gnu)
+    ffi (1.17.4-x86_64-linux-musl)
+    forwardable-extended (2.6.0)
+    google-protobuf (4.36.2)
+      bigdecimal
+      rake (~> 13.3)
+    google-protobuf (4.36.2-aarch64-linux-gnu)
+      bigdecimal
+      rake (~> 13.3)
+    google-protobuf (4.36.2-aarch64-linux-musl)
+      bigdecimal
+      rake (~> 13.3)
+    google-protobuf (4.36.2-arm64-darwin)
+      bigdecimal
+      rake (~> 13.3)
+    google-protobuf (4.36.2-x86-linux-gnu)
+      bigdecimal
+      rake (~> 13.3)
+    google-protobuf (4.36.2-x86-linux-musl)
+      bigdecimal
+      rake (~> 13.3)
+    google-protobuf (4.36.2-x86_64-darwin)
+      bigdecimal
+      rake (~> 13.3)
+    google-protobuf (4.36.2-x86_64-linux-gnu)
+      bigdecimal
+      rake (~> 13.3)
+    google-protobuf (4.36.2-x86_64-linux-musl)
+      bigdecimal
+      rake (~> 13.3)
+    http_parser.rb (0.8.1)
+    i18n (1.15.2)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.4.1)
+      addressable (~> 2.4)
+      base64 (~> 0.2)
+      colorator (~> 1.0)
+      csv (~> 3.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      json (~> 2.6)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.3, >= 0.3.6)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-feed (0.18.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-redirect-from (0.17.0)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-sass-converter (3.1.0)
+      sass-embedded (~> 1.75)
+    jekyll-seo-tag (2.9.1)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-sitemap (1.4.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    json (2.21.2)
+    kramdown (2.5.2)
+      rexml (>= 3.4.4)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.10.1)
+      logger
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.7.0)
+    mercenary (0.4.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (7.0.5)
+    rake (13.4.2)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rexml (3.4.4)
+    rouge (4.7.0)
+    safe_yaml (1.0.5)
+    sass-embedded (1.106.1)
+      google-protobuf (~> 4.31)
+      rake (~> 13.3)
+    sass-embedded (1.106.1-aarch64-linux-android)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-aarch64-linux-gnu)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-aarch64-linux-musl)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-arm-linux-androideabi)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-arm-linux-gnueabihf)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-arm-linux-musleabihf)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-arm64-darwin)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-riscv64-linux-android)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-riscv64-linux-gnu)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-riscv64-linux-musl)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-x86_64-darwin)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-x86_64-linux-android)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-x86_64-linux-gnu)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.106.1-x86_64-linux-musl)
+      google-protobuf (~> 4.31)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.6.0)
+    webrick (1.9.2)
+
+PLATFORMS
+  aarch64-linux-android
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-androideabi
+  arm-linux-gnu
+  arm-linux-gnueabihf
+  arm-linux-musl
+  arm-linux-musleabihf
+  arm64-darwin
+  riscv64-linux-android
+  riscv64-linux-gnu
+  riscv64-linux-musl
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux
+  x86_64-linux-android
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  jekyll (~> 4.4)
+  jekyll-feed
+  jekyll-redirect-from
+  jekyll-seo-tag
+  jekyll-sitemap
+  tzinfo-data
+  webrick
+
+BUNDLED WITH
+   2.7.2