build: provide version at runtime

and in title of the deployed demo
davidenke · Nov 7, 2024 · 5af57e1 · 5af57e1
1 parent ee397db
commit 5af57e1
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 4 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -70,7 +70,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pnpm install --global release-it @release-it/conventional-changelog
+          pnpm add --global tsx release-it @release-it/conventional-changelog
           cargo install cargo-bump
 
       - name: Prepare release
@@ -121,8 +121,12 @@ jobs:
         with:
           node-version-file: .nvmrc
           cache: pnpm
-      - run: pnpm install
-      - run: ./node_modules/.bin/vite build --mode detached
+      - run: |
+          pnpm install
+          pnpm add --global tsx
+      - run: |
+          pnpm dlx vite build --mode detached
+          pnpm dlx tsx scripts/set-version.ts ${{ needs.prepare.outputs.version }}
       - uses: actions/upload-pages-artifact@v3
         with:
           path: demo

diff --git a/index.html b/index.html
@@ -3,7 +3,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
-    <title>Live Protocol Demo</title>
+    <title>Live Protocol ##VERSION## Demo</title>
     <link rel="stylesheet" href="src/index.css" />
     <script type="module" src="/src/index.ts" defer></script>
   </head>

diff --git a/package.json b/package.json
@@ -49,6 +49,7 @@
     "eslint-plugin-simple-import-sort": "12.1.1",
     "eslint-plugin-unused-imports": "4.1.4",
     "eslint-plugin-wc": "2.2.0",
+    "fast-glob": "3.3.2",
     "jiti": "2.3.3",
     "postcss": "8.4.47",
     "postject": "1.0.0-alpha.6",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/set-version.ts b/scripts/set-version.ts
@@ -0,0 +1,60 @@
+// pnpm dlx tsx scripts/set-version.ts
+import { readFile, writeFile } from 'node:fs/promises';
+import { fileURLToPath } from 'node:url';
+import { parseArgs } from 'node:util';
+
+import glob from 'fast-glob';
+
+import pkg from '../package.json' assert { type: 'json' };
+import { getFileName } from '../src/utils/file.utils.js';
+
+// just call `npm run set:version` to use the package version
+// or `npm run set:version <version>` to use a custom version
+const { positionals } = parseArgs({ allowPositionals: true });
+const version = positionals[0] ?? pkg.version;
+
+// prepare version banner
+const intro = '// set live protocol version globally';
+const banner = `${intro}
+let lp = 'live-protocol';
+if (!window.enke) window.enke = {};
+if (!window.enke[lp]) window.enke[lp] = {};
+if (window.enke[lp].version) {
+  console.warn(\`> \${lp} ${version}: Another version (\${window.enke[lp].version}) has already been loaded.\`);
+} else window.enke[lp].version = '${version}';
+`;
+
+// prepend version banner to given bundle
+async function prependVersion(path: string) {
+  const { name: file } = getFileName(path);
+  const content = await readFile(path, 'utf8');
+
+  // update dist file by adding banner if not already present
+  if (!content.startsWith(intro)) {
+    console.info(`> Updating ${file} with version banner ${version}`);
+    await writeFile(path, banner + content);
+  } else {
+    console.info(`> Version banner already present in ${file}`);
+  }
+}
+
+// replace version placeholders in given file
+async function replaceVersion(path: string, placeholder = '##VERSION##') {
+  const { name: file } = getFileName(path);
+  const content = await readFile(path, 'utf8');
+
+  // replace all occurrences of search string
+  const pattern = new RegExp(placeholder, 'g');
+  await writeFile(path, content.replace(pattern, version));
+  console.info(`> Replaced version placeholders in ${file} with ${version}`);
+}
+
+async function invoke(pattern: string, fn: (path: string) => Promise<void>) {
+  const cwd = fileURLToPath(new URL('..', import.meta.url));
+  for await (const path of await glob(pattern, { onlyFiles: true, absolute: true, cwd })) {
+    await fn(path);
+  }
+}
+
+await invoke('dist/assets/index-*.js', prependVersion);
+await invoke('dist/index.html', replaceVersion);
diff --git a/src-tauri/icons/icon.icns b/src-tauri/icons/icon.icns