Special check overlays for Py2

Will be automatically filled with

    <id>:
        enabled: false
        compatible: false

for Python 2 incompatible plugins on page build, unless `id` is already
present in the data (in case of more specific overlays).

That way plugins will no longer prompt to update to Python 3 only
versions if running on Python 2 (starting with OctoPrint 1.6.0).
Alternatively, plugin authors could rewrite the update URL in such
cases, e.g. to still be notified of security updates from a legacy fork.

Author: foosel

.github/scripts/populate_py2_overlays.py

@@ -0,0 +1,91 @@
+import concurrent.futures
+import os
+import sys
+
+import frontmatter
+import pkg_resources
+import yaml
+
+
+def process_plugin_file(path):
+    output = []
+
+    def out(line, prefix="", *args, **kwargs):
+        output.append("{}{}".format(prefix, line))
+
+    overlay = {}
+
+    data = frontmatter.load(path)
+    plugin_id = data["id"]
+
+    out("Processing plugin {} at path {}".format(plugin_id, path))
+
+    if data.get("compatibility", {}).get("python"):
+        pycompat = data["compatibility"]["python"]
+        s = pkg_resources.Requirement.parse("Python" + pycompat)
+        if "2.7" not in s:
+            out(
+                "Plugin {} is not Python 2 compatible, disable update checks in the field".format(
+                    plugin_id
+                )
+            )
+            overlay = {plugin_id: {"enabled": False, "compatible": False}}
+
+    return "\n".join(output), overlay
+
+
+if __name__ == "__main__":
+    executor = concurrent.futures.ThreadPoolExecutor(max_workers=5)
+
+    filtered = None
+    if len(sys.argv) > 1:
+        filtered = sys.argv[1:]
+
+    futures_to_name = dict()
+
+    overlays_path = os.path.join(
+        os.path.dirname(os.path.abspath(__file__)),
+        "..",
+        "..",
+        "_data",
+        "update_check_overlays_py2.yaml",
+    )
+    with open(overlays_path, "r") as f:
+        data = yaml.safe_load(f)
+    assert isinstance(data, dict)
+
+    plugin_dir = os.path.join(
+        os.path.dirname(os.path.abspath(__file__)), "..", "..", "_plugins"
+    )
+    with os.scandir(plugin_dir) as it:
+        for entry in it:
+            if not entry.is_file() or not entry.name.endswith(".md"):
+                continue
+            if filtered and entry.name[:-3] not in filtered:
+                continue
+            if entry.name[:-3] in data:
+                continue
+            future = executor.submit(process_plugin_file, entry.path)
+            futures_to_name[future] = entry.name
+
+    overlays = {}
+    for future in concurrent.futures.as_completed(futures_to_name):
+        name = futures_to_name[future]
+        try:
+            output, result = future.result()
+            overlays.update(result)
+
+            print(output)
+            print("")
+        except Exception as exc:
+            print("{} generated an exception: {}".format(name, exc))
+
+    if overlays:
+        # there were overlays added, write them to the data file now
+        print("Adding {} new overlays to {}...".format(len(overlays), overlays_path))
+
+        data.update(overlays)
+        with open(overlays_path, "w") as f:
+            yaml.safe_dump(data, f)
+
+        print("Overlays added.")

.github/workflows/publish-to-github-pages.yml

@@ -59,6 +59,11 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.metadata_token }}
 
+      - name: 🏗 Enrich py2 check overlays
+        if: github.repository == 'OctoPrint/plugins.octoprint.org' && github.event_name != 'pull_request'
+        run: |
+          python ./src/.github/scripts/populate_py2_overlays.py
+
       - name: 📦 Cache jekyll build bundle
         uses: actions/cache@v2
         with:

_data/update_check_overlays_py2.yaml

@@ -0,0 +1,11 @@
+# Update check overlays for Python 2 instances specifically. Format:
+#
+#   pluginID:
+#     user: new github user
+#     repo: new github repo
+#     pip: new pip URL
+#     ...
+#
+# Any keys from the software update config can be overwritten, changing the default values. config.yaml on the
+# instances out there still wins though, in case the user has a personal override configured.
+{}

update_check_overlay_py2.json

@@ -0,0 +1,4 @@
+---
+layout: null
+---
+{{ site.data.update_check_overlays_py2 | jsonify }}