Generate a PDF for each non-snapshot version

Author: marcphilipp

.github/workflows/deploy-docs.yml

@@ -36,6 +36,10 @@ jobs:
           node-version-file: .tool-versions
           cache: npm
           cache-dependency-path: package-lock.json
+      - name: Install Ruby
+        uses: ruby/setup-ruby@ed55d55e820a01da7d3e4863a8c51a61d73c3228 # v1.274.0
+        with:
+          bundler-cache: true
       - name: Install JDKs
         uses: actions/setup-java@f2beeb24e141e01a676f977032f5a29d81c9e27e # v5.1.0
         with:
@@ -67,7 +71,6 @@ jobs:
         if: env.DEPLOY == 'true'
         run: |
           rsync --recursive --delete --checksum --archive --safe-links --human-readable --prune-empty-dirs --stats \
-            --exclude='*.pdf' \
             --exclude='_/font/roboto-*' \
             build/site/* \
             docs-repo

.tool-versions

@@ -1 +1,2 @@
 nodejs 24.12.0
+ruby 3.4.5

Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'asciidoctor-pdf'
+gem 'rouge'

Gemfile.lock

@@ -0,0 +1,65 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (2.0.1)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
+    afm (1.0.0)
+    asciidoctor (2.0.26)
+    asciidoctor-pdf (2.3.24)
+      asciidoctor (~> 2.0)
+      concurrent-ruby (~> 1.3)
+      matrix (~> 0.4)
+      prawn (~> 2.4.0)
+      prawn-icon (~> 3.0.0)
+      prawn-svg (~> 0.34.0)
+      prawn-table (~> 0.2.0)
+      prawn-templates (~> 0.1.0)
+      treetop (~> 1.6.0)
+      ttfunk (~> 1.7.0)
+    concurrent-ruby (1.3.6)
+    css_parser (1.21.1)
+      addressable
+    hashery (2.1.2)
+    matrix (0.4.3)
+    pdf-core (0.9.0)
+    pdf-reader (2.15.0)
+      Ascii85 (>= 1.0, < 3.0, != 2.0.0)
+      afm (>= 0.2.1, < 2)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    polyglot (0.3.5)
+    prawn (2.4.0)
+      pdf-core (~> 0.9.0)
+      ttfunk (~> 1.7)
+    prawn-icon (3.0.0)
+      prawn (>= 1.1.0, < 3.0.0)
+    prawn-svg (0.34.2)
+      css_parser (~> 1.6)
+      matrix (~> 0.4.2)
+      prawn (>= 0.11.1, < 3)
+      rexml (~> 3.2)
+    prawn-table (0.2.2)
+      prawn (>= 1.3.0, < 3.0.0)
+    prawn-templates (0.1.2)
+      pdf-reader (~> 2.0)
+      prawn (~> 2.2)
+    public_suffix (7.0.0)
+    rexml (3.4.4)
+    rouge (4.6.1)
+    ruby-rc4 (0.1.5)
+    treetop (1.6.18)
+      polyglot (~> 0.3)
+    ttfunk (1.7.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  asciidoctor-pdf
+  rouge
+
+BUNDLED WITH
+   2.7.1

antora-assembler.yml

@@ -0,0 +1,8 @@
+component_version_filter:
+  names: '**'
+asciidoc:
+  attributes:
+    source-highlighter: rouge
+    toc: ''
+build:
+  stderr: ignore

antora-playbook.yml

@@ -1,12 +1,16 @@
 antora:
   extensions:
     - '@antora/collector-extension'
+    - '@antora/pdf-extension'
     - require: '@antora/lunr-extension'
       index_latest_only: true
       index_by_heading: true
     - require: '@springio/antora-extensions/root-component-extension'
       root_component_name: junit
     - require: '@springio/antora-extensions/root-attachments-extension'
+    - require: './root-exports-extension.js'
+      root_component_name: junit
+      file_name: junit-user-guide
 site:
   title: JUnit User Guide
   url: https://docs.junit.org

package-lock.json

@@ -9,6 +9,7 @@
   "dependencies": {
     "@antora/collector-extension": "1.0.2",
     "@antora/lunr-extension": "1.0.0-alpha.12",
+    "@antora/pdf-extension": "^1.0.0-beta.15",
     "@springio/antora-extensions": "1.14.7",
     "highlight.js": "11.11.1"
   }

package.json

@@ -0,0 +1,48 @@
+'use strict'
+
+module.exports.register = function ({ config }) {
+  const { rootComponentName, fileName = rootComponentName } = config
+  this.on('navigationBuilt', ({ contentCatalog }) => {
+    const { versions } = contentCatalog.getComponent(rootComponentName)
+    versions.forEach(version => {
+      const file = contentCatalog.resolveResource(`${version.version}@${rootComponentName}:ROOT:index.pdf`, {}, 'export', ['export'])
+      if (file) {
+        if (version.prerelease === '-SNAPSHOT') {
+          contentCatalog.removeFile(file)
+        } else {
+          removeRootComponentNameFromFile(file, fileName)
+        }
+      }
+    })
+  })
+}
+
+function removeRootComponentNameFromFile(file, fileName) {
+  if (file.out) {
+    file.out.dirname = removeFirstSegment(file.out.dirname)
+    file.out.basename = file.out.basename.replace('index', fileName)
+    file.out.path = removeFirstSegment(file.out.path).replace('index', fileName)
+    file.out.moduleRootPath = '.'
+    file.out.rootPath = '..'
+  }
+  if (file.pub) {
+    if (file.pub.rootPath) {
+      file.pub.rootPath = '..'
+    }
+    if (file.pub.moduleRootPath) {
+      file.pub.moduleRootPath = '.'
+    }
+    file.pub.url = removeFirstSegment(file.pub.url).replace('index', fileName)
+  }
+}
+
+function removeFirstSegment(path) {
+  if (path) {
+    if (path.startsWith('/')) {
+      return ('/' + path.split('/').slice(2).join('/')) || '.'
+    } else {
+      return (path.split('/').slice(1).join('/')) || '.'
+    }
+  }
+  return path
+}

root-exports-extension.js

@@ -79,3 +79,13 @@ pre {
     padding: 1rem 1rem .75rem;
     margin: 1.5rem 0;
 }
+
+.pdf-link {
+    display: none;
+    padding-right: .7rem
+}
+@media screen and (min-width:1024px) {
+    .pdf-link {
+        display:block
+    }
+}