Rename groups to tags, and change 'force' to false by default as suggested

by Mike.

Author: Yhg1s

CHANGELOG.md

@@ -100,37 +100,35 @@ See `README.md` for more information.
 python -m pytest -m "not long_running"
 ```
 
-### Configurable groups
+### Configurable tags
 
-Runners can configure which groups they belong to, and benchmark runs can be
-started on whole groups. Unlike when using 'all' or individual runners, runs
-for which the result already exists are skipped. For example, a
-configuration like:
+Runners can have tags attached, and benchmark runs can be started on
+everything with a specific tag. For example, a configuration like:
 
 ```toml
 [runners.linux_clang]
 os = "linux"
 arch = "x86_64"
 hostname = "pyperf1"
 env.CC = "clang"
-groups = ["linux", "pyperf1", "clang"]
+tags = ["linux", "pyperf1", "clang"]
 
 [runners.linux_gcc]
 os = "linux"
 arch = "x86_64"
 hostname = "pyperf1"
-groups = ["linux", "pyperf1", "gcc"]
+tags = ["linux", "pyperf1", "gcc"]
 
 [runners.linux2_gcc]
 os = "linux"
 arch = "x86_64"
 hostname = "pyperf2"
-groups = ["linux", "pyperf2", "gcc"]
+tags = ["linux", "pyperf2", "gcc"]
 ```
 
-... will add `group linux`, `group pyperf1`, `group pyperf2`, `group gcc`
-and `group clang` to the list of possible machines for benchmark runs.
-Selecting `group linux` will queue a run for all three runners, and `group
+... will add `tag linux`, `tag pyperf1`, `tag pyperf2`, `tag gcc`
+and `tag clang` to the list of possible machines for benchmark runs.
+Selecting `tag linux` will queue a run for all three runners, and `tag
 pyperf1` only for the first two.
 
 ## v1.8.0

bench_runner/runners.py

@@ -35,7 +35,7 @@ def __init__(
         github_runner_name: str | None,
         include_in_all: bool = True,
         plot: dict[str, str] | None = None,
-        groups: list[str] | None = None,
+        tags: list[str] | None = None,
     ):
         self.nickname = nickname
         self.os = os
@@ -50,7 +50,7 @@ def __init__(
         if plot is None:
             plot = {"name": nickname}
         self.plot = PlotConfig(**plot)
-        self.groups = groups
+        self.tags = tags
 
     @property
     def name(self) -> str:
@@ -80,7 +80,7 @@ def get_runners(cfgpath: PathLike | None = None) -> list[Runner]:
                 section.get("github_runner_name"),
                 section.get("include_in_all", True),
                 section.get("plot", None),
-                section.get("groups"),
+                section.get("tags"),
             )
         )
 
@@ -123,10 +123,10 @@ def get_runner_for_hostname(
     return get_runners_by_hostname(cfgpath).get(hostname, unknown_runner)
 
 
-def get_groups(cfgpath: PathLike | None = None) -> dict[str, list[Runner]]:
+def get_tags(cfgpath: PathLike | None = None) -> dict[str, list[Runner]]:
     d = collections.defaultdict(list)
     for runner in get_runners(cfgpath):
-        if runner.groups:
-            for group in runner.groups:
-                d[group].append(runner)
+        if runner.tags:
+            for tag in runner.tags:
+                d[tag].append(runner)
     return dict(d)

bench_runner/scripts/get_merge_base.py

@@ -52,10 +52,10 @@ def _main(
     if machine in ("__really_all", "all"):
         need_to_run = True
     else:
-        if machine.startswith("group "):
-            group = machine.removeprefix("group ")
-            groups = mrunners.get_groups()
-            machines = [r.nickname for r in groups[group]]
+        if machine.startswith("tag "):
+            tag = machine.removeprefix("tag ")
+            tags = mrunners.get_tags()
+            machines = [r.nickname for r in tags[tag]]
         else:
             machines = [machine]
         for m in machines:

bench_runner/scripts/install.py

@@ -184,11 +184,11 @@ def generate__benchmark(src: Any) -> Any:
         ]
         if runner.include_in_all:
             machine_clauses.append("inputs.machine == 'all'")
-        if runner.groups:
-            for group in runner.groups:
-                if "'" in group:
-                    raise ValueError(f"group cannot contain `'` (runner {runner.name})")
-                machine_clauses.append(f"inputs.machine == 'group {group}'")
+        if runner.tags:
+            for tag in runner.tags:
+                if "'" in tag:
+                    raise ValueError(f"tag cannot contain `'` (runner {runner.name})")
+                machine_clauses.append(f"inputs.machine == 'tag {tag}'")
         runner_template["if"] = f"${{{{ ({' || '.join(machine_clauses)}) }}}}"
 
         dst["jobs"][f"benchmark-{runner.name}"] = runner_template
@@ -211,15 +211,15 @@ def generate_benchmark(dst: Any) -> Any:
     """
     Generates benchmark.yml from benchmark.src.yml.
 
-    Inserts the list of groups and available machines to the drop-down
+    Inserts the list of tags and available machines to the drop-down
     presented to the user.
     """
     available_runners = [r for r in runners.get_runners() if r.available]
-    groups = sorted(
-        set(f"group {g}" for r in available_runners if r.groups for g in r.groups)
+    tags = sorted(
+        set(f"tag {g}" for r in available_runners if r.tags for g in r.tags)
     )
     runner_choices = [
-        *groups,
+        *tags,
         *[x.name for x in available_runners],
         "all",
         "__really_all",

bench_runner/templates/benchmark.src.yml

@@ -80,7 +80,7 @@ jobs:
       benchmarks: ${{ inputs.benchmarks }}
       pgo: true
       perf: false
-      force: ${{ ! startsWith(inputs.machine, 'group ') }}
+      force: false
     secrets: inherit
 
   base: