Replace the old gh-pages workflow with an action

ultraq · ultraq · commit 832ed03dd224 · 2026-03-01T11:24:10.000+13:00
This saves me having to maintain a separate path and the git
commands used to force-push that, plus calling shell commands
from Gradle doesn't work as well with the configuration cache
and the general direction it's headed
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -0,0 +1,44 @@
+name: publish docs
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: gradle/actions/wrapper-validation@v5
+      - uses: actions/setup-java@v5
+        with:
+          distribution: 'temurin'
+          java-version: 25
+      - run: ./gradlew :thymeleaf-layout-dialect-docs:copyGroovyDocs
+      - uses: ruby/setup-ruby@4a9ddd6f338a97768b8006bf671dfbad383215f4 # https://github.com/ruby/setup-ruby/releases/tag/v1.207.0
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+      - run: bundle install
+        working-directory: ./thymeleaf-layout-dialect-docs
+      - run: bundle exec jekyll build --baseurl thymeleaf-layout-dialect
+        working-directory: ./thymeleaf-layout-dialect-docs
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: './thymeleaf-layout-dialect-docs/_site'
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: actions/deploy-pages@v4
+        id: deployment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
diff --git a/thymeleaf-layout-dialect-docs/build.gradle b/thymeleaf-layout-dialect-docs/build.gradle
@@ -1,12 +1,12 @@
-/* 
+/*
  * Copyright 2019, Emanuel Rabina (http://www.ultraq.net.nz/)
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *     http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -28,39 +28,7 @@ tasks.register('copyGroovyDocs', Copy) {
 
 tasks.register('serveDocs', Exec) {
 	dependsOn copyGroovyDocs
-	commandLine 'bundle', 'exec', 'jekyll', 'serve', '--baseurl', ""
-}
-
-tasks.register('publishDocs') {
-	dependsOn copyGroovyDocs
-	doLast {
-		execute(["git", "init"])
-		execute(["git", "checkout", "-b", "gh-pages"])
-		execute(["git", "add", "_sass"])
-		execute(["git", "add", "groovydoc", "--force"]) // Is in .gitignore but needed for docs
-		execute(["git", "add", "processors"])
-		execute(["git", "add", "_config.yml"])
-		execute(["git", "add", "favicon.ico"])
-		execute(["git", "add", "Gemfile*"])
-		execute(["git", "add", "*.md"])
-		execute(["git", "commit", "-m", "'Update docs'"])
-		execute(["git", "push", "git@github.com:ultraq/thymeleaf-layout-dialect", "gh-pages", "--force"])
-		execute(["rm", "-rf", ".git"])
-	}
-}
-
-/**
- * Execute an individual command and wait for the process to complete.
- * 
- * @param command
- */
-def execute(command) {
-	println "Executing: ${command.join(" ")}"
-	def proc = command.execute(null, projectDir)
-	proc.waitForProcessOutput(System.out, System.err)
-	if (proc.exitValue() > 0) {
-		println "${proc.err.text}"
-	}
+	commandLine 'bundle', 'exec', 'jekyll', 'serve'
 }
 
 tasks.register('cleanDocs', Exec) {
diff --git a/thymeleaf-layout-dialect-docs/configuration-options.md b/thymeleaf-layout-dialect-docs/configuration-options.md
@@ -28,7 +28,7 @@ new LayoutDialect()
 ```
 
 Sets how `<head>` elements will be sorted when combined from the layout and
-content templates.  See [`<head>` element merging]({{ site.baseurl }}{% link processors/decorate.md %}#head-element-merging)
+content templates.  See [`<head>` element merging]({% link processors/decorate.md %}#head-element-merging)
 for more details and examples.
 
 
@@ -43,7 +43,7 @@ new LayoutDialect()
 ```
 
 Bypass the layout dialect prforming any `<head>` element merging altogether.
-See [Bypassing <head> element merging altogether]({{ site.baseurl }}{% link processors/decorate.md %}#bypassing-head-element-merging-altogether)
+See [Bypassing <head> element merging altogether]({% link processors/decorate.md %}#bypassing-head-element-merging-altogether)
 for more details.
 
 
@@ -59,5 +59,5 @@ new LayoutDialect()
 
 An experimental option added in 3.4.0 to use standard Thymeleaf expression
 syntax for title patterns instead of special tokens.  See
-[Using standard Thymeleaf expression variables instead of special tokens]({{ site.baseurl }}{% link processors/title-pattern.md %}#using-standard-thymeleaf-expression-variables-instead-of-special-tokens)
+[Using standard Thymeleaf expression variables instead of special tokens]({% link processors/title-pattern.md %}#using-standard-thymeleaf-expression-variables-instead-of-special-tokens)
 for more details.
diff --git a/thymeleaf-layout-dialect-docs/getting-started.md b/thymeleaf-layout-dialect-docs/getting-started.md
@@ -65,5 +65,5 @@ This will introduce the `layout` namespace, and 5 new attribute processors that
 you can use in your templates: `decorate`, `title-pattern`, `insert`, `replace`,
 and `fragment`.
 
-Continue on to the [processors]({{ site.baseurl }}{% link processors/index.md %})
+Continue on to the [processors]({% link processors/index.md %})
 section to learn how to use these in your templates.
diff --git a/thymeleaf-layout-dialect-docs/index.md b/thymeleaf-layout-dialect-docs/index.md
@@ -98,8 +98,8 @@ When Thymeleaf processes your content template, the resulting HTML will be:
 Learn more
 ----------
 
-Check out the [getting started]({{ site.baseurl }}{% link getting-started.md %})
+Check out the [getting started]({% link getting-started.md %})
 guide to learn how to add the layout dialect to your Thymeleaf project, or the
-[processors]({{ site.baseurl}}{% link processors/index.md %}) pages for in-depth
+[processors]({% link processors/index.md %}) pages for in-depth
 examples of each of the layout dialect features and how they can help you build
 your templates.
diff --git a/thymeleaf-layout-dialect-docs/processors/insert.md b/thymeleaf-layout-dialect-docs/processors/insert.md
@@ -59,5 +59,5 @@ the result would be this:
 
 Note the surrounding `<div>` from the calling template remains.  This is in line
 with how Thymeleaf's `th:insert` behaves.  One way to remove the `<div>` would
-be to use [`layout:replace`]({{ site.baseurl }}{% link processors/replace.md %})
+be to use [`layout:replace`]({% link processors/replace.md %})
 instead, whose behaviour aligns with Thymeleaf's `th:replace`.
diff --git a/thymeleaf-layout-dialect-docs/processors/replace.md b/thymeleaf-layout-dialect-docs/processors/replace.md
@@ -55,5 +55,5 @@ the result would be this:
 
 Note the `<div>` that included the `layout:replace` processor is gone.  This is
 in line with how Thymeleaf's `th:replace` behaves.  If you need to keep the
-original element, try [`layout:insert`]({{ site.baseurl }}{% link processors/insert.md %})
+original element, try [`layout:insert`]({% link processors/insert.md %})
 instead, whose behaviour aligns with Thymeleaf's `th:insert`.
