Add workflows triggered by crons to run on the latest development versions (#66)

make_workflows.py

@@ -8,6 +8,7 @@ The point is that we had/have a lot of duplications between files in
 and keep them in sync.
 """
 
+import enum
 import pathlib
 
 import yaml
@@ -33,15 +34,36 @@ class Dumper(yaml.Dumper):
 Dumper.add_representer(script, script_representer)
 
 
-def generate_workflow(config, software_id):
+class VersionFlavor(enum.Enum):
+    STABLE = "stable"
+    """A statically defined version, that we already tested irctest on.
+    This is ran on PRs and master, because failure guarantees it's a bug in
+    the new irctest commit/PR."""
+    RELEASE = "release"
+    """The last release of the project. This should usually pass.
+    We don't currently use this."""
+    DEVEL = "devel"
+    """The last commit of the project. This allows us to catch bugs in other
+    software early in their development process."""
+    DEVEL_RELEASE = "devel_release"
+    """Ditto, but if the project uses a specific branch for their current
+    release series, it uses that branch instead"""
+
+
+def generate_workflow(config: dict, software_id: str, version_flavor: VersionFlavor):
     software_config = config["software"][software_id]
     name = software_config["name"]
     prefix = software_config.get("prefix", "~/.local")
 
     if "install_steps" in software_config:
         path = "placeholder"  # TODO: remove this
-        install_steps = software_config["install_steps"]
+        install_steps = software_config["install_steps"][version_flavor.value]
+        if install_steps is None:
+            return
     else:
+        ref = software_config["refs"][version_flavor.value]
+        if ref is None:
+            return
         path = software_config["path"]
         install_steps = [
             {
@@ -49,7 +71,7 @@ def generate_workflow(config, software_id):
                 "uses": "actions/checkout@v2",
                 "with": {
                     "repository": software_config["repository"],
-                    "ref": software_config["ref"],
+                    "ref": ref,
                     "path": path,
                 },
             },
@@ -59,9 +81,24 @@ def generate_workflow(config, software_id):
             },
         ]
 
+    on: dict
+    if version_flavor == VersionFlavor.STABLE:
+        on = {"push": None, "pull_request": None}
+    else:
+        # Run every saturday and sunday 8:51 UTC, and every day at 17:51
+        # (minute choosen at random, hours and days is so that I'm available
+        # to fix bugs it detects)
+        on = {
+            "schedule": [
+                {"cron": "51 8 * * 6"},
+                {"cron": "51 8 * * 0"},
+                {"cron": "51 17 * * *"},
+            ]
+        }
+
     workflow = {
         "name": f"irctest with {name}",
-        "on": {"push": None, "pull_request": None},
+        "on": on,
         "jobs": {
             "build": {
                 "runs-on": "ubuntu-latest",
@@ -104,7 +141,14 @@ def generate_workflow(config, software_id):
         },
     }
 
-    with open(GH_WORKFLOW_DIR / f"{software_id}.yml", "wt") as fd:
+    if version_flavor == VersionFlavor.STABLE:
+        workflow_filename = GH_WORKFLOW_DIR / f"{software_id}.yml"
+    else:
+        workflow_filename = (
+            GH_WORKFLOW_DIR / f"{software_id}_{version_flavor.value}.yml"
+        )
+
+    with open(workflow_filename, "wt") as fd:
         fd.write("# This file was auto-generated by make_workflows.py.\n")
         fd.write("# Do not edit it manually, modifications will be lost.\n\n")
         fd.write(yaml.dump(workflow, Dumper=Dumper))
@@ -115,7 +159,11 @@ def main():
         config = yaml.load(fd, Loader=yaml.Loader)
 
     for software_id in config["software"]:
-        generate_workflow(config, software_id)
+        generate_workflow(config, software_id, version_flavor=VersionFlavor.STABLE)
+        generate_workflow(config, software_id, version_flavor=VersionFlavor.DEVEL)
+        generate_workflow(
+            config, software_id, version_flavor=VersionFlavor.DEVEL_RELEASE
+        )
 
 
 if __name__ == "__main__":