Merge branch 'main' into tab-format-19-aug-24

Author: aimurphy

.github/workflows/release-ui-bundle.yml

@@ -16,7 +16,7 @@ jobs:
        - name: Configure Git Credentials
          uses: de-vri-es/setup-git-credentials@v2
          with:
-           credentials: ${{ secrets.GIT_CREDENTIALS }}
+           credentials: https://${{ secrets.DOCS_GITHUB_PAT }}@github.com
 
        - name: Checkout Repository
          uses: actions/checkout@v4
@@ -25,8 +25,6 @@ jobs:
 
        - name: Check Last Commit Message
          id: skip_release
-         env:
-           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          run: |
            last_commit_message=$(git log -1 --pretty=%B)
            if [[ $last_commit_message == *"[no-release]"* ]]; then

gulp.d/tasks/build-preview-pages.js

@@ -11,7 +11,6 @@ const { Transform } = require('stream')
 const map = (transform = () => {}, flush = undefined) => new Transform({ objectMode: true, transform, flush })
 const vfs = require('vinyl-fs')
 const yaml = require('js-yaml')
-const { execSync } = require('child_process')
 
 const ASCIIDOC_ATTRIBUTES = { experimental: '', icons: 'font', sectanchors: '', 'source-highlighter': 'highlight.js' }
 
@@ -100,7 +99,8 @@ function registerPartials (src) {
 function registerHelpers (src, previewDest) {
   handlebars.registerHelper('resolvePage', resolvePage)
   handlebars.registerHelper('resolvePageURL', resolvePageURL)
-  handlebars.registerHelper('assets-manifest', (assetPath) => assetsManifest(assetPath, previewDest))
+  // Since we are not creating an assets-manifest.json file in the preview build, we need to mock the helper.
+  handlebars.registerHelper('assets-manifest', (assetPath) => assetPath)
   return vfs.src('helpers/*.js', { base: src, cwd: src }).pipe(
     map((file, enc, next) => {
       if (!(file.stem === 'assets-manifest')) {
@@ -128,12 +128,6 @@ function compileLayouts (src) {
   )
 }
 
-function assetsManifest (assetPath, previewDest) {
-  const manifestPath = execSync(`find ${previewDest} -name assets-manifest.json`).toString().trim()
-  const manifest = JSON.parse(fs.readFileSync(manifestPath, 'utf-8'))
-  return manifest[assetPath]
-}
-
 function copyImages (src, dest) {
   return vfs
     .src('**/*.{png,svg}', { base: src, cwd: src })

gulp.d/tasks/build.js

@@ -11,6 +11,7 @@ const ospath = require('path')
 const path = ospath.posix
 const postcss = require('gulp-postcss')
 const postcssCalc = require('postcss-calc')
+const gulpif = require('gulp-if')
 const postcssAdvancedVars = require('postcss-advanced-variables')
 const postcssImport = require('postcss-import')
 const tailwindcss = require('tailwindcss')
@@ -74,34 +75,34 @@ module.exports = (src, dest, preview) => () => {
       .pipe(uglify({ output: { comments: /^! / } }))
       // NOTE concat already uses stat from newest combined file
       .pipe(concat('js/site.js'))
-      .pipe(hash({ template: '<%= name %>-<%= hash %><%= ext %>' }))
+      .pipe(gulpif(!preview, hash({ template: '<%= name %>-<%= hash %><%= ext %>' })))
       .pipe(vfs.dest(dest))
-      .pipe(hash.manifest('assets-manifest.json', { append: true }))
+      .pipe(gulpif(!preview, hash.manifest('assets-manifest.json', { append: true })))
       .pipe(vfs.dest(dest)),
     vfs
       .src('js/vendor/*([^.])?(.bundle).js', { ...opts, read: false })
       .pipe(bundle(opts))
       .pipe(uglify({ output: { comments: /^! / } }))
-      .pipe(hash({ template: '<%= name %>-<%= hash %><%= ext %>' }))
+      .pipe(gulpif(!preview, hash({ template: '<%= name %>-<%= hash %><%= ext %>' })))
       .pipe(vfs.dest(dest))
-      .pipe(hash.manifest('assets-manifest.json', { append: true }))
+      .pipe(gulpif(!preview, hash.manifest('assets-manifest.json', { append: true })))
       .pipe(vfs.dest(dest)),
     vfs
       .src('js/vendor/*.min.js', opts)
       .pipe(map((file, enc, next) => next(null, Object.assign(file, { extname: '' }, { extname: '.js' }))))
-      .pipe(hash({ template: '<%= name %>-<%= hash %><%= ext %>' }))
+      .pipe(gulpif(!preview, hash({ template: '<%= name %>-<%= hash %><%= ext %>' })))
       .pipe(vfs.dest(dest))
-      .pipe(hash.manifest('assets-manifest.json', { append: true }))
+      .pipe(gulpif(!preview, hash.manifest('assets-manifest.json', { append: true })))
       .pipe(vfs.dest(dest)),
     // NOTE use the next line to bundle a JavaScript library that cannot be browserified, like jQuery
     //vfs.src(require.resolve('<package-name-or-require-path>'), opts).pipe(concat('js/vendor/<library-name>.js')),
     vfs.src('./tailwind.config.js').pipe(concat('js/tailwind.config.js')),
     vfs
       .src(['css/site.css', 'css/vendor/*.css'], { ...opts, sourcemaps })
       .pipe(postcss((file) => ({ plugins: postcssPlugins, options: { file } })))
-      .pipe(hash({ template: '<%= name %>-<%= hash %><%= ext %>' }))
+      .pipe(gulpif(!preview, hash({ template: '<%= name %>-<%= hash %><%= ext %>' })))
       .pipe(vfs.dest(dest))
-      .pipe(hash.manifest('assets-manifest.json', { append: true }))
+      .pipe(gulpif(!preview, hash.manifest('assets-manifest.json', { append: true })))
       .pipe(vfs.dest(dest)),
     vfs.src('font/*.{ttf,woff*(2)}', opts),
     vfs.src('img/**/*.{gif,ico,jpg,png,svg}', opts).pipe(

package-lock.json

@@ -39,6 +39,7 @@
     "gulp-connect": "~5.7",
     "gulp-eslint": "~6.0",
     "gulp-hash": "^4.2.2",
+    "gulp-if": "^3.0.0",
     "gulp-imagemin": "~6.2",
     "gulp-postcss": "~9.0",
     "gulp-uglify": "~3.0",

package.json

@@ -1,18 +1,19 @@
 'use strict'
 
-const { execSync } = require('child_process')
-const fs = require('fs')
 const logger = require('@antora/logger')('assets-manifest-helper')
 
 module.exports = (assetPath) => {
-  let manifestPath
-  let manifest
-  try {
-    manifestPath = execSync('find ./build/site -name assets-manifest.json').toString().trim()
-    manifest = JSON.parse(fs.readFileSync(manifestPath, 'utf-8'))
-  } catch (err) {
-    logger.error(err)
+  const manifest = global.assetsManifest
+  if (!manifest) {
+    logger.error(
+      `
+      Assets manifest not found in global context.
+      The .js and .css files from the UI bundle will not be linked properly in the HTML.
+      Ensure assets-manifest.json from the UI bundle is parsed and added 
+      to global.assetsManifest after uiLoader is complete.
+      `
+    )
+    return assetPath
   }
-  if (manifest) return manifest[assetPath]
-  return assetPath
+  return manifest[assetPath]
 }