Skip to content

Update gh-pages GitHub Action to use shared version in .github repo #344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
stumbo wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Update gh-pages GitHub Action to use shared version in .github repo #344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ee5551e
Update gh-pages GitHub Action to use shared version in .github repo
stumbo Aug 11, 2026
51fb3db
Fix typo.
stumbo Aug 11, 2026
258be54
Test passing HUGO_VERSION as an output of check job.
stumbo Aug 12, 2026
3bbd261
Move Zotero interactions into shared build-site workflow.
stumbo Aug 12, 2026
54048ac
Re-add per-PR staging preview phase and flip shared workflow pin to @…
stumbo Aug 14, 2026
bcb22b0
Updates to move staging site to Interlisp.staging
stumbo Aug 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
256 changes: 84 additions & 172 deletions .github/workflows/gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,31 @@
#*******************************************************************************
# gh-pages.yml
#
# Github Workflow to deploy Interlisp.org.
# Github Workflow to deploy Interlisp.org.
#
# Interlisp.org is a Hugo based static website that contains a
# detailed bibliography maintained using Zotero (https://www.zotero.org/groups/2914042/interlispwww.zotero.org/).
# Interlisp.org is a Hugo based static website that contains a
# detailed bibliography maintained using Zotero (https://www.zotero.org/groups/2914042/interlispwww.zotero.org/).
#
# This workflow consists of two jobs, one to ensure that we have the latest
# version of the Zotero bibliography and a second job to deploy the website.
# This workflow consists of several jobs:
#
# The workflow is executed either on a push or via scheduled run times. When
# started at a scheduled run time we only do a deploy if the cached bibliography
# is no longer current. On a push, we always verifty the the current
# bibliography is loaded and deploy a new version of the website.
# validate-docs - ensure README.md references the correct Hugo version
# hugo-version - expose the Hugo version as a job output
# build - build the website and run the full test suite using the
# org-level reusable workflow; also checks the Zotero
# bibliography version (skipping the build on scheduled
# runs when it is unchanged)
# (Interlisp/shared-workflows/.github/workflows/build-site.yml)
# preview - trigger a per-PR staging preview in
# Interlisp/Interlisp.staging (skips on fork PRs or when
# the STAGING_APP_ID variable is unset)
# deploy - deploy the built site to GitHub Pages
#
# 2023-10-20 Bill Stumbo
# The workflow is executed either on a push or via scheduled run times. When
# started at a scheduled run time we only do a deploy if the cached bibliography
# is no longer current. On a push, we always verify the the current
# bibliography is loaded and deploy a new version of the website.
#
# 2023-10-20 Bill Stumbo
#
# Copyright 2023 by Interlisp.org
#
Expand Down Expand Up @@ -49,47 +60,9 @@ defaults:
shell: bash

env:
# ----------------------------------------------------------------------------
# Specify the deployment environment: staging or production
HUGO_ENVIRONMENT: ${{ vars.HUGO_ENVIRONMENT || 'staging' }}
HUGO_VERSION: 0.155.3

jobs:
# ----------------------------------------------------------------------------
# Use the Zotero REST API to get the current version of the Zotero Bibliography
# Compare against a cached version of the bibliography.
#
check:
outputs:
zoteroVersion: ${{ steps.zoteroVersion.outputs.version }}
cacheHit: ${{ steps.cache-zotero.outputs.cache-hit }}

runs-on: ubuntu-latest
steps:

- name: Get Zotero Version Information
id: zoteroVersion
run: |
set -euo pipefail
VERSION=$(curl -fsSLI "https://api.zotero.org/groups/2914042/items?format=versions" \
| { grep -i "last-modified-version" \
| cut -d: -f2 \
| tr -d $'\r ' || true; })
if [[ -z "${VERSION:-}" ]]; then
echo "Error: Failed to determine Zotero Last-Modified-Version from API response." >&2
exit 1
fi
echo "version=$VERSION" >> "$GITHUB_OUTPUT"

- name: Cache Zotero Bibliography
id: cache-zotero
uses: actions/cache/restore@v5
with:
lookup-only: true
path: |
content/en/history/bibliography
key: bib-${{ steps.zoteroVersion.outputs.version }}

# ----------------------------------------------------------------------------
# Validate that README.md references the correct Hugo version.
# Only runs on push/pull_request, not scheduled runs.
Expand Down Expand Up @@ -124,149 +97,88 @@ jobs:
echo "README.md Hugo version references are consistent"

# ----------------------------------------------------------------------------
# Run the bibliography JSON-LD test suite against a test-environment Hugo
# build that mounts tests/fixtures/bibliography/ alongside the real content.
# This job must pass before changes can be merged or deployed.
# Expose the Hugo version from the workflow environment as a job output.
# The env context is not available in a reusable workflow's `with:` block,
# so the version is surfaced here instead. Keeping it in the workflow `env`
# means version bumps are ordinary, reviewed pull requests.
#
test:
needs: [check, validate-docs]
if: always() && (github.event_name == 'push' || github.event_name == 'pull_request' || needs.check.outputs.cacheHit != 'true') && (needs.validate-docs.result == 'success' || needs.validate-docs.result == 'skipped') && (needs.check.result == 'success' || needs.check.result == 'skipped')
hugo-version:
runs-on: ubuntu-latest
outputs:
version: ${{ env.HUGO_VERSION }}
steps:
- uses: actions/checkout@v6
with:
submodules: recursive
fetch-depth: 0

- name: Cache Zotero Bibliography
id: cache-bib
uses: actions/cache@v5
with:
path: |
static/data/bibliography.json
static/data/bibItems
content/en/history/bibliography
key: bib-${{ needs.check.outputs.zoteroVersion }}

- name: Install Bibliography
if: steps.cache-bib.outputs.cache-hit != 'true'
run: |
echo "Retrieve bibliography"
cd scripts
chmod +x ./update_bibliography.sh
chmod +x ./bibSplit.pl
./update_bibliography.sh

- name: Install Hugo CLI
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb

- name: Setup Node
uses: actions/setup-node@v6
with:
node-version: 24
cache: 'npm'

- name: Install Node dependencies
run: npm ci

- name: Build test site
- name: Verify Hugo version is set
env:
HUGO_CACHEDIR: ${{ runner.temp }}/hugo_cache
TZ: America/New_York
run: hugo --environment testing --destination tests/public_test

- name: Install pytest
run: pip install pytest pyyaml pytest-cov

- name: Run content-integrity tests
run: pytest tests/test_content_integrity.py -v --cov-report=term-missing

- name: Run JSON-LD tests
run: pytest tests/test_bibliography_jsonld.py -v
VERSION: ${{ env.HUGO_VERSION }}
run: |
[[ -n "$VERSION" ]] || { echo "::error::HUGO_VERSION is empty"; exit 1; }
echo "Hugo version: $VERSION"

# ----------------------------------------------------------------------------
# Build the website. This job is conditional, we will always run it on a
# push or if on a scheduled run the cache was determined to be out of date.
#
# Build the website using the org-level reusable workflow. This job is
# conditional, we will always run it on a push or if on a scheduled run the
# cache was determined to be out of date.
#
build:
needs: [check, validate-docs, test]
if: always() && (github.event_name == 'push' || github.event_name == 'pull_request' || needs.check.outputs.cacheHit != 'true') && (needs.validate-docs.result == 'success' || needs.validate-docs.result == 'skipped') && (needs.check.result == 'success' || needs.check.result == 'skipped') && (needs.test.result == 'success')
needs: [validate-docs, hugo-version]
if: always() && (needs.validate-docs.result == 'success' || needs.validate-docs.result == 'skipped') && (needs.hugo-version.result == 'success')
uses: Interlisp/shared-workflows/.github/workflows/build-site.yml@main
with:
hugo-version: ${{ needs.hugo-version.outputs.version }}
hugo-environment: ${{ vars.HUGO_ENVIRONMENT || 'production' }}
skip-if-fresh: ${{ github.event_name == 'schedule' }}

# ----------------------------------------------------------------------------
# Trigger a per-PR staging preview in Interlisp/Interlisp.staging. Skips on
# fork pull requests and when the GitHub App credentials are not configured,
# so the workflow remains green during rollout. The Hugo version is passed
# as a dispatch input (a step can read the env context, unlike a reusable
# workflow call), keeping gh-pages.yml's env the single source of truth.
#
preview:
if: github.event_name == 'pull_request' &&
github.event.pull_request.head.repo.full_name == github.repository &&
vars.STAGING_APP_ID != ''
runs-on: ubuntu-latest
needs: [build]
steps:
- uses: actions/checkout@v6
- name: Mint GitHub App token
id: app-token
uses: actions/create-github-app-token@v3
with:
submodules: recursive
fetch-depth: 0

- name: Cache Zotero Bibliography
id: cache-bib
uses: actions/cache@v5
client-id: ${{ vars.STAGING_APP_ID }}
private-key: ${{ secrets.STAGING_APP_PRIVATE_KEY }}
owner: Interlisp
repositories: |
Interlisp.staging

- name: Trigger staging preview
uses: benc-uk/workflow-dispatch@v1
with:
path: |
static/data/bibliography.json
static/data/bibItems
content/en/history/bibliography
key: bib-${{ needs.check.outputs.zoteroVersion }}

- name: Install Bibliography
if: steps.cache-bib.outputs.cache-hit != 'true'
run: |
echo "Retrieve bibliography"
cd scripts
chmod +x ./update_bibliography.sh
chmod +x ./bibSplit.pl
./update_bibliography.sh

# Install Hugo Extended
#
- name: Install Hugo CLI
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb

- name: Setup Pages
id: pages
uses: actions/configure-pages@v6.0.0

- name: Setup Node
uses: actions/setup-node@v6
with:
node-version: 24
cache: 'npm'

- name: Install dependencies
run: |
npm ci

- name: Build
env:
HUGO_CACHEDIR: ${{ runner.temp }}/hugo_cache
TZ: America/New_York
run: hugo --cleanDestinationDir -e $HUGO_ENVIRONMENT

- name: Install pytest
run: pip install pytest pytest-cov

- name: Run build-integrity tests
run: pytest tests/test_hugo_build.py -v

- name: Upload artifact
uses: actions/upload-pages-artifact@v5.0.0
with:
path: ./public
workflow: deploy-preview.yml
repo: Interlisp/Interlisp.staging
ref: main
token: ${{ steps.app-token.outputs.token }}
inputs: '{
"pr_number": "${{ github.event.pull_request.number }}",
"pr_sha": "${{ github.event.pull_request.head.sha }}",
"hugo_version": "${{ env.HUGO_VERSION }}"
}'

# ----------------------------------------------------------------------------
# Deploy the built site to GitHub Pages.
# Only runs on push or scheduled runs, never on pull requests, and never
# when the build was skipped because the bibliography was already current.
#
deploy:
if: github.event_name != 'pull_request'
if: github.event_name != 'pull_request' && needs.build.outputs.skipped != 'true'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: [build, test]
needs: [build]

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5

46 changes: 46 additions & 0 deletions .github/workflows/preview-cleanup.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
#*******************************************************************************
# preview-cleanup.yml
#
# GitHub Workflow that removes the staging preview for a pull request once
# the pull request is closed or merged.
#
# Triggers the remove-preview workflow in the Interlisp/Interlisp.staging
# repository, which deletes the pr-<N>/ subdirectory from the staging
# Pages site.
#
# Copyright 2026 by Interlisp.org
#
# ******************************************************************************
name: Preview Cleanup

on:
pull_request:
branches:
- main
types: [closed]

jobs:
remove-preview:
if: vars.STAGING_APP_ID != ''
runs-on: ubuntu-latest
steps:
- name: Mint GitHub App token
id: app-token
uses: actions/create-github-app-token@v3
with:
client-id: ${{ vars.STAGING_APP_ID }}
private-key: ${{ secrets.STAGING_APP_PRIVATE_KEY }}
owner: Interlisp
repositories: |
Interlisp.staging

- name: Trigger staging preview removal
uses: benc-uk/workflow-dispatch@v1
with:
workflow: remove-preview.yml
repo: Interlisp/Interlisp.staging
ref: main
token: ${{ steps.app-token.outputs.token }}
inputs: '{
"pr_number": "${{ github.event.pull_request.number }}"
}'
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ tests/public_test/
node_modules/
_gen/
.hugo_build.lock
.coverage
tests/__pycache__/
_vendor/
.idea
data/bibliography.json
static/data/bibliography.json
Expand Down
Loading