Add build timestamp to index.html for easier release tracking

solacecommunity · Dec 19, 2024 · 0e2241c · 0e2241c
1 parent 6dbd9b2
commit 0e2241c
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -73,6 +73,13 @@ Open a browser and navigate to http://localhost:4173/stable/ or http://localhost
 
 _Commit the changes and push back to the repo_
 ```
+git add -A
 git commit -a -m "Update latest with new feature ..."
 git push origin gh-pages
+```
+
+A note to maintainers: the build process will insert a timestamp into the `index.html` which can be observed for troubleshooting by inspecting the page content. For example, the HTML of the website should begin as follows:
+```
+<!doctype html>
+<html lang="en" data-build-time="2024-12-19T22:03:42.043Z">
 ```
diff --git a/index.html b/index.html
@@ -1,5 +1,5 @@
 <!doctype html>
-<html lang="en">
+<html lang="en" data-build-time="%BUILD_TIME%">
   <head>
     <meta charset="UTF-8" />
     <link rel="icon" href="./favicon.ico" />

diff --git a/vite.config.js b/vite.config.js
@@ -19,4 +19,7 @@ export default defineConfig(async () => ({
       ignored: ["**/src-tauri/**"],
     },
   },
+  define: {
+    'import.meta.env.BUILD_TIME': JSON.stringify(new Date().toISOString()),    
+  }
 }));