Set up deployment

.github/workflows/gh-pages.yml

@@ -0,0 +1,67 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+
+env:
+  HUGO_VERSION: 0.147.8
+  GH_USER: site-commons-machine-user
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GH_SITE_COMMONS_PAT }}
+          submodules: true
+          fetch-depth: 0
+
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@v3
+        with:
+          hugo-version: ${{ env.HUGO_VERSION }}
+          extended: true
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Cache Hugo Modules
+        uses: actions/cache@v4
+        with:
+          path: /tmp/hugo_cache
+          key: ${{ runner.os }}-hugomod-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-hugomod-
+
+      - name: Prepare Environment
+        run: git config --global url."https://${{ env.GH_USER }}:${{ secrets.GH_SITE_COMMONS_PAT }}@github.com".insteadOf "https://github.com"
+
+      - name: Install Dependencies
+        working-directory: site
+        run: npm ci
+
+      - name: Build Spine
+        working-directory: site
+        run: hugo --minify
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: ./site/public

.github/workflows/proof-links.yml

@@ -1,37 +1,113 @@
 name: Proof Links
+on: [pull_request, workflow_dispatch]
 
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
+env:
+  HUGO_VERSION: 0.147.8
+  GH_USER: site-commons-machine-user
+  LYCHEE_RELEASE: "lychee-v0.15.1-x86_64-unknown-linux-gnu.tar.gz"
+  LYCHEE_VERSION_TAG: "v0.15.1"
 
 jobs:
   proof-links:
     runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@v3
+        with:
+          hugo-version: ${{ env.HUGO_VERSION }}
+          extended: true
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Cache Hugo Modules
+        uses: actions/cache@v4
+        with:
+          path: /tmp/hugo_cache
+          key: ${{ runner.os }}-hugomod-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-hugomod-
+
+      - name: Prepare environment
+        run: git config --global url."https://${{ env.GH_USER }}:${{ secrets.GH_SITE_COMMONS_PAT }}@github.com".insteadOf "https://github.com"
+
+      - name: Install Dependencies
+        working-directory: site
+        run: npm ci
+
+      - name: Build Spine
+        working-directory: site
+        run: hugo -e development
+
+      # Cache Lychee results to avoid hitting rate limits.
+      - name: Cache Lychee results
+        uses: actions/cache@v4
         with:
-          submodules: 'recursive'
+          path: .lycheecache
+          key: cache-lychee-results
 
-      - name: Set up Ruby and Bundler
-        uses: ruby/setup-ruby@v1
+      - name: Cache Lychee executable
+        id: cache-lychee
+        uses: actions/cache@v4
         with:
-          ruby-version: '2.7.4'
-
-      # Bundler version is restricted to `2.4.22`,
-      # as we want to use Ruby `2.7.4` to match GH Pages environment.
-      #
-      # Any newer versions of Bundler require Ruby 3.x,
-      # which are much newer than what's GH Pages has at the moment.
-      #
-      - name: Run Jekyll build
+          path: lychee
+          key: ${{ runner.os }}-${{ env.LYCHEE_RELEASE }}
+
+      # We use Lychee directly instead of a GitHub Action because it
+      # must have access the local Hugo server, which is not visible
+      # from the Docker-based action.
+      - name: Download Lychee executable
+        uses: robinraju/release-downloader@v1.7
+        if: steps.cache-lychee.outputs.cache-hit != 'true'
+        with:
+          repository: "lycheeverse/lychee"
+          tag: ${{ env.LYCHEE_VERSION_TAG }}
+          fileName: ${{ env.LYCHEE_RELEASE }}
+
+      - name: Extract Lychee executable
+        if: steps.cache-lychee.outputs.cache-hit != 'true'
         run: |
-          gem install bundler -v 2.4.22
-          bundle install
-          bundle exec jekyll build
+          mkdir -p lychee &&
+          tar -xf ${{ env.LYCHEE_RELEASE }} -C lychee
 
-      - name: Proof Links
-        run: ./_script/proof-links
+      # 1. In the generated HTML, some inner links will have absolute URLs and
+      #    the link checker will attempt to fetch them. That's why we need
+      #    a server. Sadly, link checkers have no settings to address this.
+      # 2. Output redirection is necessary for nohup in GitHub Actions.
+      # 3. Sleep makes sure the server is up before the next step.
+      - name: Start Hugo server
+        working-directory: site
+        run: |
+          nohup hugo server \
+          --environment development \
+          > nohup.out 2> nohup.err < /dev/null & 
+          sleep 5
+
+      - name: Check if the cache file exists
+        run: |
+          if [ -f ".lycheecache" ]; then
+            echo "Lychee cache exists."
+          else
+            echo "No lychee cache file."
+          fi
+
+      - name: Check links
+        run: |
+          ./lychee/lychee --config lychee.toml --timeout 60 \
+          --base http://localhost:1313/ \
+          'site/public/**/*.html'

.gitignore

@@ -1,20 +1,21 @@
-# The result of Jekyll build
-_site/
+# Hugo cache files
+/site/resources
+public
 
-# Intermediate directory used by `embed-code` Jekyll subcommand
-.fragments
+# Cache folder for Hugo Modules
+/site/_vendor
 
-.sass-cache
-.jekyll-metadata
-.DS_Store
+# Node modules
+node_modules
 
-*/build/
+# Used to control concurrency between multiple Hugo instances
+/site/.hugo_build.lock
 
-**/*.jar
+# Needed for navigation help inside code editors
+jsconfig.json
 
-# Do not ignore the Gradle Wrapper at the top level and in the sub-projects that are
-# added as included builds. See `settings.gradle.kts` for details.
-!**/gradle/wrapper/*
+# The temporary Lychee cache obtained from local check
+.lycheecache
 
 # IntelliJ IDEA modules and interim config files
 *.iml
@@ -29,6 +30,8 @@ _site/
 !.idea/codeStyles/
 !.idea/copyright/
 
+.DS_Store
+
 # Gradle interim configs
 .gradle/
 

.gitmodules

@@ -13,9 +13,3 @@
 [submodule "_code/examples/todo-list"]
 	path = _code/examples/todo-list
 	url = https://github.com/spine-examples/todo-list
-[submodule "_code/config"]
-	path = config
-	url = https://github.com/SpineEventEngine/config
-[submodule "_docs"]
-	path = _docs
-	url = https://github.com/SpineEventEngine/documentation.git