mkhtml: Generate local JSON file with core modules and their last commit

.github/workflows/gen_pgms_last_commit_json_file.yml

@@ -0,0 +1,30 @@
+name: Generate PGMS last commit JSON file
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'releasebranch_7_8'
+      - 'releasebranch_8_0'
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+
+      - name: Execute script
+        working-directory: ./utils
+        run: |
+          python gen_pgms_last_commit.py ../
+
+      - uses: actions/upload-artifact@v2
+        with:
+          name: pgms-with-last-commit-json-file
+          path: pgms_with_last_commit.json

utils/gen_pgms_last_commit.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+
+"""
+Script for creating an pgms_with_last_commit.json file contains all pgms
+with their last commit
+{"pgm": {"commit": "git log -1 PGM src dir"}}.
+
+Used by GitHub actions workflow.
+
+python gen_pgms_last_commit.py src_root_dir
+
+@author Tomas Zigo <tomas.zigo slovanet.sk>
+"""
+
+import json
+import os
+import subprocess
+import shutil
+import sys
+
+
+def get_last_commit(src_dir):
+    """Generate JSON object with the following structure e.g.
+    {"pgm": {"commit": "git log -1 PGM src dir"}}
+
+    :param str src_dir: root src dir
+
+    :return JSON obj result: JSON object
+    """
+    result = {}
+    if not shutil.which("git"):
+        sys.exit("Git command was not found. Please install it.")
+    for root, dirs, files in os.walk(src_dir):
+        for f in files:
+            if f.endswith(".html"):
+                rel_path = os.path.relpath(root)
+                stdout, stderr = subprocess.Popen(
+                    ["git", "log", "-1", rel_path],
+                    stdout=subprocess.PIPE,
+                    stderr=subprocess.PIPE,
+                ).communicate()
+                if stderr:
+                    sys.exit(stderr.decode())
+                if stdout:
+                    result[os.path.basename(rel_path)] = {
+                        "commit": stdout.decode(),
+                    }
+    return result
+
+
+def main():
+    if len(sys.argv) < 2:
+        sys.exit("Set root source dir script arg, please.")
+    src_dir = sys.argv[1]
+    with open(os.path.join(src_dir, "pgms_with_last_commit.json"), "w") as f:
+        json.dump(get_last_commit(src_dir), f, indent=4)
+
+
+if __name__ == "__main__":
+    main()

utils/mkhtml.py

@@ -48,15 +48,7 @@
     import grass.script as gs
 except ImportError:
     # During compilation GRASS GIS
-    _ = str
-
-    class gs:
-        def warning(message):
-            pass
-
-        def fatal(message):
-            pass
-
+    gs = None
 
 HEADERS = {
     "User-Agent": "Mozilla/5.0",
@@ -199,6 +191,12 @@ def get_last_git_commit(src_dir, is_addon, addon_path):
                           possible download commit from GitHub API server
                           values of keys have "unknown" string
     """
+
+    def parse_commit():
+        git_log["commit"] = commit[0].split(" ")[-1]
+        commit_date = commit[2].lstrip("Date:").strip()
+        git_log["date"] = commit_date.rsplit(" ", 1)[0]
+
     unknown = "unknown"
     git_log = {"commit": unknown, "date": unknown}
     datetime_format = "%A %b %d %H:%M:%S %Y"  # e.g. Sun Jan 16 23:09:35 2022
@@ -234,24 +232,34 @@ def get_last_git_commit(src_dir, is_addon, addon_path):
         stderr = decode(stderr)
 
         if stderr and "fatal: not a git repository" in stderr:
-            response = download_git_commit(
-                url=grass_addons_url if is_addon else grass_modules_url,
-                response_format="application/json",
-            )
-            if response:
-                commit = json.loads(response.read())
-                if commit:
-                    git_log["commit"] = commit[0]["sha"]
-                    git_log["date"] = datetime.strptime(
-                        commit[0]["commit"]["author"]["date"],
-                        "%Y-%m-%dT%H:%M:%SZ",
-                    ).strftime(datetime_format)
+            if gs:
+                response = download_git_commit(
+                    url=grass_addons_url if is_addon else grass_modules_url,
+                    response_format="application/json",
+                )
+                if response:
+                    commit = json.loads(response.read())
+                    if commit:
+                        git_log["commit"] = commit[0]["sha"]
+                        git_log["date"] = datetime.strptime(
+                            commit[0]["commit"]["author"]["date"],
+                            "%Y-%m-%dT%H:%M:%SZ",
+                        ).strftime(datetime_format)
+            else:
+                pgms_with_last_commit = os.path.join(
+                    topdir,
+                    "pgms_with_last_commit.json",
+                )
+                if os.path.exists(pgms_with_last_commit):
+                    with open(pgms_with_last_commit) as f:
+                        pgms_with_last_commit = json.load(f)
+                    if pgm in pgms_with_last_commit:
+                        commit = pgms_with_last_commit[pgm]["commit"].splitlines()
+                        parse_commit()
         else:
             if stdout:
                 commit = stdout.splitlines()
-                git_log["commit"] = commit[0].split(" ")[-1]
-                commit_date = commit[2].lstrip("Date:").strip()
-                git_log["date"] = commit_date.rsplit(" ", 1)[0]
+                parse_commit()
     return git_log