feat(core): Log and display git commit id

Hypfer · Mar 7, 2021 · 2d94408 · 2d94408
1 parent 1c8c667
commit 2d94408
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 2 deletions.
diff --git a/client/settings-info.html b/client/settings-info.html
@@ -65,6 +65,14 @@
                 ???
             </div>
         </ons-list-item>
+        <ons-list-item>
+            <div class="left">
+                Running commit id:
+            </div>
+            <div class="right" id="info_valetudo_commit">
+                ???
+            </div>
+        </ons-list-item>
         <ons-list-item>
             <div class="left">
                 Newest Valetudo version:

diff --git a/client/settings-info.js b/client/settings-info.js
@@ -11,6 +11,7 @@ async function updateSettingsInfoPage() {
     try {
         let valetudoVersionRes = await ApiService.getValetudoVersion();
         document.getElementById("info_valetudo_version").innerText = valetudoVersionRes.release;
+        document.getElementById("info_valetudo_commit").innerText = valetudoVersionRes.commit;
 
         let robotRes = await ApiService.getRobot();
         document.getElementById("info_device_valetudo_implementation").innerText = robotRes.implementation;

diff --git a/lib/Tools.js b/lib/Tools.js
@@ -46,6 +46,23 @@ class Tools {
 
         return valetudoVersion;
     }
+
+    static GET_COMMIT_ID() {
+        let commitId = "unknown";
+
+        try {
+            const rootDirectory = path.resolve(__dirname, "..");
+            commitId = fs.readFileSync(rootDirectory + "/.git/HEAD", {"encoding": "utf-8"}).trim();
+
+            if(commitId.match(/^ref: refs\/heads\/master$/) !== null) {
+                commitId = fs.readFileSync(rootDirectory + "/.git/refs/heads/master", {"encoding": "utf-8"}).trim();
+            }
+        } catch (e) {
+            //intentional
+        }
+
+        return commitId;
+    }
 }
 
 module.exports = Tools;
diff --git a/lib/Valetudo.js b/lib/Valetudo.js
@@ -39,6 +39,7 @@ class Valetudo {
         }
 
         Logger.info("Starting Valetudo " + Tools.GET_VALETUDO_VERSION());
+        Logger.info("Commit ID: " + Tools.GET_COMMIT_ID());
         Logger.info("Configuration file: " + this.config.location);
         Logger.info("Logfile: " + Logger.LogFile);
         Logger.info("Robot: " + this.robot.getManufacturer() + " " + this.robot.getModelName() + " (" + this.robot.constructor.name + ")");

diff --git a/lib/webserver/ValetudoRouter.js b/lib/webserver/ValetudoRouter.js
@@ -33,7 +33,8 @@ class ValetudoRouter {
     initRoutes() {
         this.router.get("/version", (req, res) => {
             res.json({
-                release: Tools.GET_VALETUDO_VERSION()
+                release: Tools.GET_VALETUDO_VERSION(),
+                commit: Tools.GET_COMMIT_ID()
             });
         });
 

diff --git a/package.json b/package.json
@@ -7,7 +7,9 @@
   "license": "Apache-2.0",
   "pkg": {
     "assets": [
-      "client/**/*"
+      "client/**/*",
+      ".git/HEAD",
+      ".git/refs/heads/master"
     ]
   },
   "scripts": {