docs: prepare docs for canary releases

mrholek · mrholek · commit 43e0869ee4fd · 2025-02-12T18:12:03.000+01:00
diff --git a/build/generate-sri.mjs b/build/generate-sri.mjs
@@ -14,12 +14,16 @@ import fs from 'node:fs'
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
 import sh from 'shelljs'
+import pkg from '../package.json' with { type: 'json' }
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
 sh.config.fatal = true
 
 const configFile = path.join(__dirname, '../hugo.yml')
+const isCanaryVersion = pkg.version.includes('canary')
+
+console.log(isCanaryVersion)
 
 // Array of objects which holds the files to generate SRI hashes for.
 // `file` is the path from the root folder
@@ -69,12 +73,13 @@ for (const { file, configPropertyName } of files) {
       throw error
     }
 
+    const propertyName = isCanaryVersion ? `canary_${configPropertyName}` : configPropertyName
     const algorithm = 'sha384'
     const hash = crypto.createHash(algorithm).update(data, 'utf8').digest('base64')
     const integrity = `${algorithm}-${hash}`
 
-    console.log(`${configPropertyName}: ${integrity}`)
+    console.log(`${propertyName}: ${integrity}`)
 
-    sh.sed('-i', new RegExp(`^(\\s+${configPropertyName}:\\s+["'])\\S*(["'])`), `$1${integrity}$2`, configFile)
+    sh.sed('-i', new RegExp(`^(\\s+${propertyName}:\\s+["'])\\S*(["'])`), `$1${integrity}$2`, configFile)
   })
 }
diff --git a/docs/layouts/shortcodes/callout-canary-releases.html b/docs/layouts/shortcodes/callout-canary-releases.html
@@ -0,0 +1,10 @@
+<div class="docs-callout docs-callout-info">
+  <p>
+    <strong>Canary Releases</strong>
+  </p>
+  <p>
+    CoreUI provides canary releases, enabling you to test new, unreleased features as soon as our team determines that the latest version is ready to ship; however, we want to conduct additional tests before the final release.
+  </p>
+    Canary versions provide early access to upcoming changes, enabling developers to experiment with new functionalities before they are officially released. This is a great way to provide feedback to maintainers and ensure that the latest improvements work as expected.
+  </p>
+</div>
diff --git a/docs/layouts/shortcodes/canary-version.html b/docs/layouts/shortcodes/canary-version.html
@@ -0,0 +1,3 @@
+{{- if $.Site.Params.cdn.canary_css -}}
+{{- .Inner | markdownify -}}
+{{- end -}}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{{- if $.Site.Params.cdn.canary_css -}}`
	`2`	`+{{- .Inner \| markdownify -}}`
	`3`	`+{{- end -}}`