Merge pull request #626 from derbyjs/fix-pages-1

[docs] Fix Pages build, update workflow to trigger build-only on branches

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

@@ -1,10 +1,15 @@
 # Based on https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml
-name: Deploy Jekyll site to Pages
+name: Build Jekyll site, Deploy to Pages when on default branch
+
+env:
+  DOCS_DIR: docs
 
 on:
-  # Runs on pushes targeting the default branch
+  # Run workflow on any branch push.
+  # Conditionals are used to only trigger deploy on the default branch.
   push:
-    branches: ["master"]
+    # Uncomment to only run on specific branch pushes.
+    # branches: ["master"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -15,10 +20,10 @@ permissions:
   pages: write
   id-token: write
 
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+# Allow only one concurrent deployment per branch, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow the deployments to complete.
 concurrency:
-  group: "pages"
+  group: "pages-${{ github.ref }}"
   cancel-in-progress: false
 
 jobs:
@@ -32,26 +37,27 @@ jobs:
         uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0
         with:
           ruby-version: '3.2' # Not needed with a .ruby-version file
-          # 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
+          working-directory: ${{ env.DOCS_DIR }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          # cache-version: 0 # Increment this number if the cache gets corrupted and you need to force-update cached gems
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v4
       - name: Build with Jekyll
         # Outputs to the './_site' directory by default
-        # If changing the name of the 'docs' directory, also change the path input
-        # in upload-pages-artifact below.
-        run: cd docs && bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        run: cd $DOCS_DIR && bundle install && bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
         env:
           JEKYLL_ENV: production
       - name: Upload artifact
-        # Automatically uploads an artifact from the './_site' directory by default
+        if: github.ref == 'refs/heads/master' # Only upload when on default branch
         uses: actions/upload-pages-artifact@v3
         with:
-          path: "./docs/_site"
+          # Default path is './_site'.
+          path: "./${{ env.DOCS_DIR }}/_site"
 
   # Deployment job
   deploy:
+    if: github.ref == 'refs/heads/master' # Only deploy when on default branch
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}