Merge pull request #123 from javaevolved/og-svg-card-generator

Add OG social preview SVG card generator

Author: brunoborges

.github/workflows/build-generator.yml

@@ -1,11 +1,12 @@
-name: Build Generator JAR
+name: Build Generator JARs
 
 on:
   push:
     branches: [main]
     paths:
       - '.github/workflows/build-generator.yml'
       - 'html-generators/generate.java'
+      - 'html-generators/generateog.java'
   schedule:
     - cron: '0 6 * * 1'   # every Monday at 06:00 UTC
   workflow_dispatch:
@@ -15,7 +16,7 @@ permissions:
   actions: write
 
 jobs:
-  build:
+  build-generate:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
@@ -40,3 +41,29 @@ jobs:
             html-generators/generate.jar
             html-generators/generate.aot
           key: generator-${{ hashFiles('html-generators/generate.java') }}
+
+  build-generateog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-java@v5
+        with:
+          distribution: 'temurin'
+          java-version: '25'
+
+      - uses: jbangdev/setup-jbang@main
+
+      - name: Build fat JAR
+        run: jbang export fatjar --force --output html-generators/generateog.jar html-generators/generateog.java
+
+      - name: Build AOT cache
+        run: java -XX:AOTCacheOutput=html-generators/generateog.aot -jar html-generators/generateog.jar
+
+      - name: Save to cache
+        uses: actions/cache/save@v5
+        with:
+          path: |
+            html-generators/generateog.jar
+            html-generators/generateog.aot
+          key: generateog-${{ hashFiles('html-generators/generateog.java') }}

.github/workflows/deploy.yml

@@ -8,8 +8,9 @@ on:
       - 'translations/**'
       - 'templates/**'
       - 'site/**'
+      - 'html-generators/generateog.java'
   workflow_run:
-    workflows: ['Build Generator JAR']
+    workflows: ['Build Generator JARs']
     types: [completed]
     branches: [main]
   workflow_dispatch:
@@ -35,7 +36,7 @@ jobs:
           distribution: 'temurin'
           java-version: '25'
 
-      - name: Restore cached JAR and AOT
+      - name: Restore cached generate JAR and AOT
         id: cache-restore
         uses: actions/cache/restore@v5
         with:
@@ -44,18 +45,41 @@ jobs:
             html-generators/generate.aot
           key: generator-${{ hashFiles('html-generators/generate.java') }}
 
-      - name: Generate with cached JAR + AOT
+      - name: Generate HTML with cached JAR + AOT
         if: steps.cache-restore.outputs.cache-hit == 'true'
         run: java -XX:AOTCache=html-generators/generate.aot -jar html-generators/generate.jar
 
       - name: Setup JBang (cache miss)
         if: steps.cache-restore.outputs.cache-hit != 'true'
         uses: jbangdev/setup-jbang@main
 
-      - name: Generate with JBang (cache miss)
+      - name: Generate HTML with JBang (cache miss)
         if: steps.cache-restore.outputs.cache-hit != 'true'
         run: jbang html-generators/generate.java
 
+      - name: Restore cached generateog JAR and AOT
+        id: cache-restore-og
+        uses: actions/cache/restore@v5
+        with:
+          path: |
+            html-generators/generateog.jar
+            html-generators/generateog.aot
+          key: generateog-${{ hashFiles('html-generators/generateog.java') }}
+
+      - name: Generate OG cards with cached JAR + AOT
+        if: steps.cache-restore-og.outputs.cache-hit == 'true'
+        run: java -XX:AOTCache=html-generators/generateog.aot -jar html-generators/generateog.jar
+
+      - name: Generate OG cards with JBang (cache miss)
+        if: steps.cache-restore-og.outputs.cache-hit != 'true'
+        run: |
+          if ! command -v jbang &> /dev/null; then
+            echo "Installing JBang..."
+            curl -Ls https://sh.jbang.dev | bash -s - app setup
+            export PATH="$HOME/.jbang/bin:$PATH"
+          fi
+          jbang html-generators/generateog.java
+
       - name: Setup Pages
         uses: actions/configure-pages@v5
 

.gitignore

@@ -26,3 +26,8 @@ html-generators/generate.aot
 html-generators/generate.jar
 html-generators/generate.jsa
 html-generators/generate.classlist
+html-generators/generateog.aot
+html-generators/generateog.jar
+
+# Generated OG social preview SVGs (built by html-generators/generateog.java)
+site/og/

html-generators/generate.java

@@ -487,6 +487,7 @@ String generateHtml(Templates tpl, Snippet s, Map<String, Snippet> all, Map<Stri
             Map.entry("supportBadge", supportBadge(s.supportState(), extraTokens)),
             Map.entry("supportBadgeClass", supportBadgeClass(s.supportState())),
             Map.entry("canonicalUrl", canonicalUrl),
+            Map.entry("ogImage", "%s/og/%s/%s.png".formatted(BASE_URL, s.category(), s.slug())),
             Map.entry("flatUrl", "%s/%s.html".formatted(BASE_URL, s.slug())),
             Map.entry("titleJson", jsonEscape(s.title())), Map.entry("summaryJson", jsonEscape(s.summary())),
             Map.entry("categoryDisplayJson", jsonEscape(s.catDisplay())),