Don't include google-common-protos in API projects by default

We generally don't use it, so there is no point in including it by
default. If it is needed, it can be added manually.

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

Author: llucax

RELEASE_NOTES.md

@@ -19,6 +19,7 @@
 ### Cookiecutter template
 
 * Group GitHub Actions dependabot updates.
+* API projects don't include the `google-common-protos` dependency by default.
 
 ## Bug Fixes
 

cookiecutter/{{cookiecutter.github_repo_name}}/.gitmodules

@@ -1,7 +1,4 @@
 {% if cookiecutter.type == "api" -%}
-[submodule "submodules/api-common-protos"]
-	path = submodules/api-common-protos
-	url = https://github.com/googleapis/api-common-protos.git
 [submodule "submodules/frequenz-api-common"]
 	path = submodules/frequenz-api-common
 	url = https://github.com/frequenz-floss/frequenz-api-common.git

cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml

@@ -44,7 +44,6 @@ dependencies = [
 {%- elif cookiecutter.type == "api" %}
 dependencies = [
   "frequenz-api-common >= 0.5.0, < 0.6.0",
-  "googleapis-common-protos >= 1.56.2, < 2",
   "grpcio >= 1.51.1, < 2",
 ]
 {%- else %}

src/frequenz/repo/config/__init__.py

@@ -340,8 +340,8 @@
 # Glob pattern to use to find the proto files in the proto_path (default: "*.proto")
 proto_glob = "*.prt"  # Default: "*.proto"
 # List of paths to pass to the protoc compiler as include paths (default:
-# ["submodules/api-common-protos", "submodules/frequenz-api-common/proto"])
-include_paths = ["submodules/api-common-protos"]
+# ["submodules/frequenz-api-common/proto"])
+include_paths = ["submodules/frequenz-api-common/proto"]
 # Path where to generate the Python files (default: "py")
 py_path = "generated"
 # Path where to generate the documentation files (default: "protobuf-reference")
@@ -376,23 +376,18 @@
 section plus the following:
 
 - `pytests/`: Directory containing the tests for the Python code.
-- `submodules/api-common-protos`: Directory containing the Git submodule with the
-  `google/api-common-protos` repository.
 - `submodules/frequenz-api-common`: Directory containing the Git submodule with the
   `frequenz-floss/frequenz-api-common` repository.
 
 Normally Frequenz APIs use basic types from
-[`google/api-common-protos`](https://github.com/googleapis/api-common-protos) and
 [`frequenz-floss/frequenz-api-common`](https://github.com/frequenz-floss/frequenz-api-common),
 so you need to make sure the proper submodules are added to your project:
 
 ```sh
 mkdir submodules
-git submodule add https://github.com/googleapis/api-common-protos.git \
-        submodules/api-common-protos
 git submodule add https://github.com/frequenz-floss/frequenz-api-common.git \
         submodules/frequenz-api-common
-git commit -m "Add api-common-protos and frequenz-api-common submodules" submodules
+git commit -m "Add frequenz-api-common submodule" submodules
 ```
 
 Then you need to add this package as a build dependency and a few extra
@@ -435,13 +430,11 @@
 ```
 
 Finally you need to make sure to include the generated `*.pyi` files in the
-source distribution, as well as the Google api-common-protos files, as it
-is not handled automatically yet
+source distribution, as it is not handled automatically yet
 ([#13](https://github.com/frequenz-floss/frequenz-repo-config-python/issues/13)).
 Make sure to include these lines in the `MANIFEST.in` file:
 
 ```
-recursive-include submodules/api-common-protos/google *.proto
 recursive-include submodules/frequenz-api-common/proto *.proto
 ```
 

src/frequenz/repo/config/protobuf.py

@@ -27,10 +27,7 @@ class ProtobufConfig:
     proto_glob: str = "*.proto"
     """The glob pattern to use to find the protobuf files."""
 
-    include_paths: Sequence[str] = (
-        "submodules/api-common-protos",
-        "submodules/frequenz-api-common/proto",
-    )
+    include_paths: Sequence[str] = ("submodules/frequenz-api-common/proto",)
     """The paths to add to the include path when compiling the protobuf files."""
 
     py_path: str = "py"

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/.gitmodules

@@ -1,6 +1,3 @@
-[submodule "submodules/api-common-protos"]
-	path = submodules/api-common-protos
-	url = https://github.com/googleapis/api-common-protos.git
 [submodule "submodules/frequenz-api-common"]
 	path = submodules/frequenz-api-common
 	url = https://github.com/frequenz-floss/frequenz-api-common.git

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml

@@ -29,7 +29,6 @@ requires-python = ">= 3.11, < 4"
 # TODO(cookiecutter): Remove and add more dependencies if appropriate
 dependencies = [
   "frequenz-api-common >= 0.5.0, < 0.6.0",
-  "googleapis-common-protos >= 1.56.2, < 2",
   "grpcio >= 1.51.1, < 2",
 ]
 dynamic = ["version"]