Remove the _extensions key from the replay file

It is not needed in the generated project, we always want to use the
ones from the repo-config template.

This should ease upgrading projects, making it less likely to have
errors about missing extensions.

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

Author: llucax

RELEASE_NOTES.md

@@ -10,7 +10,7 @@
 
 ### Cookiecutter template
 
-<!-- Here upgrade steps for cookiecutter specifically -->
+- If your replay file contains a `_extensions` key, you should remove it, as you most likely want to use the extensions declared by the repo-config cookiecutter template you are upgrading to, otherwise you could get errors about missing extensions.
 
 ## New Features
 
@@ -25,6 +25,12 @@
 
   This makes it easier to upgrade projects to new templates, as removing whole lines is easier than having to edit them.
 
+- Clean up `_extensions` from the generated replay file.
+
+  It is not needed in the generated project, we always want to use the ones from the repo-config template.
+
+  This should ease upgrading projects, making it less likely to have errors about missing extensions.
+
 ## Bug Fixes
 
 <!-- Here goes notable bug fixes that are worth a special mention or explanation -->

cookiecutter/hooks/post_gen_project.py

@@ -155,6 +155,11 @@ def clean_replay_file(
     # the generated project.
     replay_data["cookiecutter"].pop("_output_dir", None)
 
+    # Remove the _extensions key from the replay data because it is not needed in the
+    # generated project, we always want to use the ones from the repo-config template.
+    # This should ease upgrading.
+    replay_data["cookiecutter"].pop("_extensions", None)
+
     if template := replay_data["cookiecutter"].get("_template"):
         if not template.startswith(("gh:", "git@", "https://")):
             print(

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/.cookiecutter-replay.json

@@ -13,17 +13,6 @@
     "python_package": "frequenz.actor.test",
     "pypi_package_name": "frequenz-actor-test",
     "github_repo_name": "frequenz-actor-test",
-    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)",
-    "_extensions": [
-      "local_extensions.as_identifier",
-      "local_extensions.default_codeowners",
-      "local_extensions.github_repo_name",
-      "local_extensions.introduction",
-      "local_extensions.keywords",
-      "local_extensions.pypi_package_name",
-      "local_extensions.python_package",
-      "local_extensions.src_path",
-      "local_extensions.title"
-    ]
+    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)"
   }
 }

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/.cookiecutter-replay.json

@@ -13,17 +13,6 @@
     "python_package": "frequenz.api.test",
     "pypi_package_name": "frequenz-api-test",
     "github_repo_name": "frequenz-api-test",
-    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)",
-    "_extensions": [
-      "local_extensions.as_identifier",
-      "local_extensions.default_codeowners",
-      "local_extensions.github_repo_name",
-      "local_extensions.introduction",
-      "local_extensions.keywords",
-      "local_extensions.pypi_package_name",
-      "local_extensions.python_package",
-      "local_extensions.src_path",
-      "local_extensions.title"
-    ]
+    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)"
   }
 }

tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/.cookiecutter-replay.json

@@ -13,17 +13,6 @@
     "python_package": "frequenz.app.test",
     "pypi_package_name": "frequenz-app-test",
     "github_repo_name": "frequenz-app-test",
-    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)",
-    "_extensions": [
-      "local_extensions.as_identifier",
-      "local_extensions.default_codeowners",
-      "local_extensions.github_repo_name",
-      "local_extensions.introduction",
-      "local_extensions.keywords",
-      "local_extensions.pypi_package_name",
-      "local_extensions.python_package",
-      "local_extensions.src_path",
-      "local_extensions.title"
-    ]
+    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)"
   }
 }

tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/.cookiecutter-replay.json

@@ -13,17 +13,6 @@
     "python_package": "frequenz.test",
     "pypi_package_name": "frequenz-test",
     "github_repo_name": "frequenz-test-python",
-    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)",
-    "_extensions": [
-      "local_extensions.as_identifier",
-      "local_extensions.default_codeowners",
-      "local_extensions.github_repo_name",
-      "local_extensions.introduction",
-      "local_extensions.keywords",
-      "local_extensions.pypi_package_name",
-      "local_extensions.python_package",
-      "local_extensions.src_path",
-      "local_extensions.title"
-    ]
+    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)"
   }
 }

tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/.cookiecutter-replay.json

@@ -13,17 +13,6 @@
     "python_package": "frequenz.model.test",
     "pypi_package_name": "frequenz-model-test",
     "github_repo_name": "frequenz-model-test",
-    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)",
-    "_extensions": [
-      "local_extensions.as_identifier",
-      "local_extensions.default_codeowners",
-      "local_extensions.github_repo_name",
-      "local_extensions.introduction",
-      "local_extensions.keywords",
-      "local_extensions.pypi_package_name",
-      "local_extensions.python_package",
-      "local_extensions.src_path",
-      "local_extensions.title"
-    ]
+    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)"
   }
 }