Add CODEOWNERS file in cookiecutter (frequenz-floss#49)

We'll have more filters that need this.

- Add a function to get a key from the JSON file
- Emphasize that TODOs need to be FIXED
- Add CODEOWNERS file

Fix frequenz-floss#2.

Author: llucax

cookiecutter/cookiecutter.json

@@ -19,8 +19,10 @@
 	"python_package": "{{cookiecutter | python_package}}",
 	"pypi_package_name": "{{cookiecutter | pypi_package_name}}",
 	"github_repo_name": "{{cookiecutter | github_repo_name}}",
+	"default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)",
 	"_extensions": [
 		"jinja2_time.TimeExtension",
+		"local_extensions.default_codeowners",
 		"local_extensions.github_repo_name",
 		"local_extensions.keywords",
 		"local_extensions.pypi_package_name",

cookiecutter/hooks/post_gen_project.py

@@ -47,7 +47,7 @@ def main() -> None:
     success(f"Your 🍪 {cookiecutter.github_repo_name} has been cut!")
     print()
     print_generated_tree()
-    print("Here is a list of things that should be reviewed and fixed:")
+    print("Here is a list of things that should be reviewed and FIXED:")
     print_todos()
     print()
     print(

cookiecutter/local_extensions.py

@@ -27,6 +27,19 @@ def _build_identifier(repo_type: str, name: str, separator: str) -> str:
     return f"frequenz{separator}{middle}{name}"
 
 
+def _get_from_json(key: str) -> str:
+    """Get a string from the cookiecutter.json file.
+
+    Args:
+        key: The key to get the string for.
+
+    Returns:
+        The string from the cookiecutter.json file.
+    """
+    with open("../cookiecutter.json", encoding="utf8") as cookiecutter_json_file:
+        return _json.load(cookiecutter_json_file)[key]
+
+
 # Ignoring because cookiecutter simple_filter decorator is not typed.
 @_simple_filter  # type: ignore[misc]
 def python_package(cookiecutter: dict[str, str]) -> str:
@@ -80,14 +93,55 @@ def keywords(cookiecutter: dict[str, str]) -> str:
         The extended keywords.
     """
     repo_type = cookiecutter["type"]
-    extended_keywords = ["frequenz", repo_type]
+    extended_keywords = ["frequenz", "python", repo_type]
     if repo_type == "api":
-        extended_keywords.append("grpc")
+        extended_keywords.extend(["grpc", "protobuf", "rpc"])
     extended_keywords.append(cookiecutter["name"])
-    with open("../cookiecutter.json", encoding="utf8") as cookiecutter_json_file:
-        no_input = _json.load(cookiecutter_json_file)["keywords"]
+    default = _get_from_json("keywords")
     cookiecutter_keywords = cookiecutter["keywords"]
-    if cookiecutter_keywords == no_input:
+    if cookiecutter_keywords == default:
         cookiecutter_keywords = ""
     extended_keywords.extend(k.strip() for k in cookiecutter_keywords.split(","))
     return _json.dumps(extended_keywords)
+
+
+@_simple_filter  # type: ignore[misc]
+def default_codeowners(cookiecutter: dict[str, str]) -> str:
+    """Build a default description for the project.
+
+    Args:
+        cookiecutter: The cookiecutter context.
+
+    Returns:
+        The default description.
+    """
+    repo_type = cookiecutter["type"]
+
+    codeowners = cookiecutter["default_codeowners"]
+    default = _get_from_json("default_codeowners")
+    if codeowners != default:
+        return codeowners
+
+    github_org = _get_from_json("github_org")
+    if github_org != "frequenz-floss":
+        return f"TODO(cookiecutter): Add codeowners (like @{github_org}/some-team)"
+
+    match repo_type:
+        case "actor":
+            return (
+                "TODO(cookiecutter): Add codeowners (like @{github_org}/some-team)"
+                "# Temporary, should probably change"
+            )
+        case "api":
+            return "@freqenz-floss/api-team"
+        case "lib":
+            return "@freqenz-floss/python-sdk-team"
+        case "app":
+            return (
+                "@freqenz-floss/python-sdk-team @frequenz-floss/datasci-team "
+                "# Temporary, should probably change"
+            )
+        case "model":
+            return "@freqenz-floss/datasci-team"
+        case _:
+            assert False, f"Unhandled repository type {repo_type!r}"

cookiecutter/{{cookiecutter.github_repo_name}}/CODEOWNERS

@@ -0,0 +1,8 @@
+# Each line is a file pattern followed by one or more owners.
+# Owners will be requested for review when someone opens a pull request.
+
+# Fallback owner.
+# These are the default owners for everything in the repo, unless a later match
+# takes precedence.
+# TODO(cookiecutter): Add more specific code-owners, check if the default is correct
+* {{ cookiecutter | default_codeowners }}