Use the new private ARM runner for private repositories

We used to use the same name for our private ARM runner as the public
one from GitHub, so we could easily re-use the same workflow for private
and public repos. This doesn't work anymore because GitHub now randomly
picks any runner with that name, and if it is a public one, then it will
refuse to run for private repos. Because of this we now use the suffix
`-arm64` for our private ARM runner, and we target the right runner
based on the `github.repository_visibility` context variable.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

.github/workflows/ci.yaml

@@ -30,7 +30,7 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
@@ -41,7 +41,7 @@ jobs:
           # that uses the same venv to run multiple linting sessions
           - "ci_checks_max"
           - "pytest_min"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Run nox
@@ -107,13 +107,13 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
           - "3.11"
           - "3.12"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Setup Git

RELEASE_NOTES.md

@@ -36,3 +36,4 @@ But you might still need to adapt your code:
 ### Cookiecutter template
 
 - mkdocstrings: Move `paths` key to the right section in `mkdocs.yml`.
+- The CI workflow now uses the new private ARM runner for private repositories (and the public ARM runners for public repositories).

cookiecutter/migrate.py

@@ -45,6 +45,11 @@ def main() -> None:
     print("Fixing wrongly located `paths` keys in mkdocs.yml...")
     migrate_mkdocs_yaml(Path("mkdocs.yml"))
     print("=" * 72)
+    print("Migrating GitHub workflows to use the new arm64 runner...")
+    workflow_dir = Path(".github/workflows")
+    for workflow_file in [workflow_dir / "release.yaml", workflow_dir / "ci.yaml"]:
+        migrate_arm64_ci_yaml(workflow_file)
+    print("=" * 72)
     print("Migration script finished. Remember to follow any manual instructions.")
     print("=" * 72)
 
@@ -221,6 +226,40 @@ def migrate_mkdocs_yaml(file_path: Path) -> None:
     file_path.write_text("".join(new_lines), encoding="utf-8")
 
 
+def migrate_arm64_ci_yaml(file_path: Path) -> None:
+    """Migrate the CI YAML file to use arm64 architecture."""
+    print(f"  - {file_path}")
+    if not file_path.is_file():
+        manual_step(f"File {file_path} does not exist, skipping automatic migration.")
+        return
+
+    lines = file_path.read_text(encoding="utf-8").splitlines(keepends=True)
+    new_lines: list[str] = []
+
+    for line in lines:
+        # 1) Replace "- arm" with "- arm64" (preserve indentation)
+        if match := re.match(r"^(\s*)-\s*arm(64)?\s*$", line):
+            indent = match.group(1)
+            new_lines.append(f"{indent}- arm64\n")
+            continue
+
+        # 2) Update the runs-on line
+        if match := re.match(r"^(\s*)runs-on:\s*\$\{\{.*matrix\.arch.*\}\}\s*$", line):
+            indent = match.group(1)
+            new_line = (
+                f"{indent}runs-on: ${{{{ matrix.os }}}}"
+                f"${{{{ matrix.arch == 'arm64' && "
+                f"(github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}}}\n"
+            )
+            new_lines.append(new_line)
+            continue
+
+        # Otherwise, keep the line as-is
+        new_lines.append(line)
+
+    file_path.write_text("".join(new_lines), encoding="utf-8")
+
+
 def apply_patch(patch_content: str) -> None:
     """Apply a patch using the patch utility."""
     subprocess.run(["patch", "-p1"], input=patch_content.encode(), check=True)

cookiecutter/{{cookiecutter.github_repo_name}}/.github/workflows/ci.yaml

@@ -63,7 +63,7 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
@@ -74,7 +74,7 @@ jobs:
           # that uses the same venv to run multiple linting sessions
           - "ci_checks_max"
           - "pytest_min"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Run nox
@@ -147,13 +147,13 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
           - "3.11"
           - "3.12"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Setup Git

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/.github/workflows/ci.yaml

@@ -30,7 +30,7 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
@@ -41,7 +41,7 @@ jobs:
           # that uses the same venv to run multiple linting sessions
           - "ci_checks_max"
           - "pytest_min"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Run nox
@@ -114,13 +114,13 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
           - "3.11"
           - "3.12"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Setup Git

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/.github/workflows/ci.yaml

@@ -60,7 +60,7 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
@@ -71,7 +71,7 @@ jobs:
           # that uses the same venv to run multiple linting sessions
           - "ci_checks_max"
           - "pytest_min"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Run nox
@@ -144,13 +144,13 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
           - "3.11"
           - "3.12"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Setup Git

tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/.github/workflows/ci.yaml

@@ -30,7 +30,7 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
@@ -41,7 +41,7 @@ jobs:
           # that uses the same venv to run multiple linting sessions
           - "ci_checks_max"
           - "pytest_min"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Run nox
@@ -114,13 +114,13 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
           - "3.11"
           - "3.12"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Setup Git

tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/.github/workflows/ci.yaml

@@ -30,7 +30,7 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
@@ -41,7 +41,7 @@ jobs:
           # that uses the same venv to run multiple linting sessions
           - "ci_checks_max"
           - "pytest_min"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Run nox
@@ -114,13 +114,13 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
           - "3.11"
           - "3.12"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Setup Git

tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/.github/workflows/ci.yaml

@@ -30,7 +30,7 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
@@ -41,7 +41,7 @@ jobs:
           # that uses the same venv to run multiple linting sessions
           - "ci_checks_max"
           - "pytest_min"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Run nox
@@ -114,13 +114,13 @@ jobs:
       matrix:
         arch:
           - amd64
-          - arm
+          - arm64
         os:
           - ubuntu-24.04
         python:
           - "3.11"
           - "3.12"
-    runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
+    runs-on: ${{ matrix.os }}${{ matrix.arch == 'arm64' && (github.repository_visibility == 'private' && '-arm64' || '-arm') || '' }}
 
     steps:
       - name: Setup Git