docs build consistency pass

Author: rlindner81

.github/workflows/build-and-deploy-docs.yml

@@ -23,6 +23,9 @@ concurrency:
 jobs:
   build:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -31,16 +34,15 @@ jobs:
         with:
           ruby-version: "3.3"
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-          working-directory: docs
+          working-directory: ${{ github.workspace }}/docs
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5
-        # Outputs to the 'docs/_site' directory
       - name: Build with Jekyll
-        uses: actions/jekyll-build-pages@v1
-        with:
-          source: docs
-          destination: docs/_site
+        # Outputs to the 'docs/_site' directory
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
       - name: Upload artifact
         # Uploads artifact from the 'docs/_site' directory
         uses: actions/upload-pages-artifact@v3

docs/.gitignore

@@ -1,5 +1,12 @@
-_site
-.sass-cache
-.jekyll-cache
+# These are directly copied from Jekyll's first-party docs on `.gitignore` files:
+# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control
+
+# Ignore the default location of the built site, and caches and metadata generated by Jekyll
+_site/
+.sass-cache/
+.jekyll-cache/
 .jekyll-metadata
-vendor
+
+# Ignore folders generated by Bundler
+.bundle/
+vendor/

docs/Gemfile.lock

@@ -35,8 +35,9 @@ GEM
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
     execjs (2.9.1)
-    faraday (2.11.0)
+    faraday (2.12.0)
       faraday-net_http (>= 2.0, < 3.4)
+      json
       logger
     faraday-net_http (3.3.0)
       net-http
@@ -220,6 +221,7 @@ GEM
       gemoji (>= 3, < 5)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
+    json (2.7.2)
     just-the-docs (0.10.0)
       jekyll (>= 3.8.5)
       jekyll-include-cache