docs: Add latest commit to top of index

d3zd3z · d3zd3z · commit 679a33cf8523 · 2025-02-18T12:43:42.000-07:00
Insert `git show --stat HEAD` into the template for the top-level docs,
to make it easy to see what a build was generated for.

Signed-off-by: David Brown &lt;david.brown@linaro.org&gt;
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -47,7 +47,7 @@ jobs:
           west build -t rustdoc -b qemu_cortex_m3 docgen
           mkdir rustdocs
           mv build/rust/target/thumbv7m-none-eabi/doc rustdocs/nostd
-          cp docs/top-index.html rustdocs/index.html
+          python3 etc/add-hash.py
 
       - name: Build build documentation
         working-directory: zephyr-lang-rust
diff --git a/docs/top-index.html b/docs/top-index.html
@@ -6,6 +6,9 @@
 </head>
 <body>
     <h1>Documentation Index</h1>
+    <pre>
+{{COMMIT}}
+    </pre>
     <ul>
         <li><a href="nostd/zephyr/index.html">zephyr crate Documentation</a></li>
         <li><a href="std/zephyr_build/index.html">zephyr_build support Documentation</a></li>
diff --git a/etc/add-hash.py b/etc/add-hash.py
@@ -0,0 +1,21 @@
+#! /usr/bin/env python
+
+import os
+import subprocess
+
+input = "./docs/top-index.html"
+output = "rustdocs/index.html"
+
+try:
+    commit_info = subprocess.check_output(["git", "show", "--stat", "HEAD"], text=True)
+except subprocess.CalledProcessError as e:
+    print(f"Error getting commit info: {e}")
+    commit_info = "Error retrieving commit details.\n"
+
+with open(output, "w") as outfile:
+    with open(input, "r") as file:
+        for line in file:
+            if "{{COMMIT}}" in line:
+                outfile.write(commit_info)
+            else:
+                outfile.write(line)
