From 632283d1acb2a42194e1f7048e986437d5567060 Mon Sep 17 00:00:00 2001 From: Leandro Lucarella Date: Wed, 10 Jul 2024 12:45:03 +0200 Subject: [PATCH 1/2] Prepare the release notes for v0.10.0 release Signed-off-by: Leandro Lucarella --- RELEASE_NOTES.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 8d9d9390..00366b2d 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -2,12 +2,10 @@ ## Summary - +This release includes quite a few enhancements and bug fixes for the cookiecutter template, but most importantly a new script for migrating to new templates, generating the templates is no longer needed for upgrading. ## Upgrading - - ### Cookiecutter template - A new script for migrating to new templates (instead of regenerating all files) is provided. It can't handle the upgrade 100% automatically, but should make the migration process much easier and less error prone. @@ -28,10 +26,6 @@ - A new GitHub ruleset is provided to configure the merge queue, so branch protection rules are not needed anymore. -### Cookiecutter template - - - ## Enhancements - The generated docs now show the symbol type in the table of contents. From 297b184200f3aa2d4ab1a117e00d4204d4149a35 Mon Sep 17 00:00:00 2001 From: Leandro Lucarella Date: Wed, 10 Jul 2024 12:48:58 +0200 Subject: [PATCH 2/2] Update version in the template pyproject.toml Signed-off-by: Leandro Lucarella --- .../{{cookiecutter.github_repo_name}}/pyproject.toml | 8 ++++---- .../actor/frequenz-actor-test/pyproject.toml | 8 ++++---- .../api/frequenz-api-test/pyproject.toml | 8 ++++---- .../app/frequenz-app-test/pyproject.toml | 8 ++++---- .../lib/frequenz-test-python/pyproject.toml | 8 ++++---- .../model/frequenz-model-test/pyproject.toml | 8 ++++---- 6 files changed, 24 insertions(+), 24 deletions(-) diff --git a/cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml b/cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml index a72bd512..97087f6f 100644 --- a/cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml +++ b/cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml @@ -5,7 +5,7 @@ requires = [ "setuptools == 70.1.1", "setuptools_scm[toml] == 8.1.0", - "frequenz-repo-config[{{cookiecutter.type}}] == 0.9.2", + "frequenz-repo-config[{{cookiecutter.type}}] == 0.10.0", ] build-backend = "setuptools.build_meta" @@ -78,7 +78,7 @@ dev-mkdocs = [ "mkdocs-material == 9.5.27", "mkdocstrings[python] == 0.25.1", "mkdocstrings-python == 1.10.5", - "frequenz-repo-config[{{cookiecutter.type}}] == 0.9.2", + "frequenz-repo-config[{{cookiecutter.type}}] == 0.10.0", ] dev-mypy = [ "mypy == 1.9.0", @@ -91,7 +91,7 @@ dev-mypy = [ ] dev-noxfile = [ "nox == 2024.4.15", - "frequenz-repo-config[{{cookiecutter.type}}] == 0.9.2", + "frequenz-repo-config[{{cookiecutter.type}}] == 0.10.0", ] dev-pylint = [ # dev-pytest already defines a dependency to pylint because of the examples @@ -101,7 +101,7 @@ dev-pylint = [ dev-pytest = [ "pytest == 8.2.2", "pylint == 3.2.5", # We need this to check for the examples - "frequenz-repo-config[extra-lint-examples] == 0.9.2", + "frequenz-repo-config[extra-lint-examples] == 0.10.0", {%- if cookiecutter.type != "api" %} "pytest-mock == 3.14.0", "pytest-asyncio == 0.23.7", diff --git a/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml index 34613791..c4e517a1 100644 --- a/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml +++ b/tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml @@ -5,7 +5,7 @@ requires = [ "setuptools == 70.1.1", "setuptools_scm[toml] == 8.1.0", - "frequenz-repo-config[actor] == 0.9.2", + "frequenz-repo-config[actor] == 0.10.0", ] build-backend = "setuptools.build_meta" @@ -60,7 +60,7 @@ dev-mkdocs = [ "mkdocs-material == 9.5.27", "mkdocstrings[python] == 0.25.1", "mkdocstrings-python == 1.10.5", - "frequenz-repo-config[actor] == 0.9.2", + "frequenz-repo-config[actor] == 0.10.0", ] dev-mypy = [ "mypy == 1.9.0", @@ -70,7 +70,7 @@ dev-mypy = [ ] dev-noxfile = [ "nox == 2024.4.15", - "frequenz-repo-config[actor] == 0.9.2", + "frequenz-repo-config[actor] == 0.10.0", ] dev-pylint = [ # dev-pytest already defines a dependency to pylint because of the examples @@ -80,7 +80,7 @@ dev-pylint = [ dev-pytest = [ "pytest == 8.2.2", "pylint == 3.2.5", # We need this to check for the examples - "frequenz-repo-config[extra-lint-examples] == 0.9.2", + "frequenz-repo-config[extra-lint-examples] == 0.10.0", "pytest-mock == 3.14.0", "pytest-asyncio == 0.23.7", "async-solipsism == 0.6", diff --git a/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml index 86247686..1752cb1e 100644 --- a/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml +++ b/tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml @@ -5,7 +5,7 @@ requires = [ "setuptools == 70.1.1", "setuptools_scm[toml] == 8.1.0", - "frequenz-repo-config[api] == 0.9.2", + "frequenz-repo-config[api] == 0.10.0", ] build-backend = "setuptools.build_meta" @@ -58,7 +58,7 @@ dev-mkdocs = [ "mkdocs-material == 9.5.27", "mkdocstrings[python] == 0.25.1", "mkdocstrings-python == 1.10.5", - "frequenz-repo-config[api] == 0.9.2", + "frequenz-repo-config[api] == 0.10.0", ] dev-mypy = [ "mypy == 1.9.0", @@ -69,7 +69,7 @@ dev-mypy = [ ] dev-noxfile = [ "nox == 2024.4.15", - "frequenz-repo-config[api] == 0.9.2", + "frequenz-repo-config[api] == 0.10.0", ] dev-pylint = [ # dev-pytest already defines a dependency to pylint because of the examples @@ -79,7 +79,7 @@ dev-pylint = [ dev-pytest = [ "pytest == 8.2.2", "pylint == 3.2.5", # We need this to check for the examples - "frequenz-repo-config[extra-lint-examples] == 0.9.2", + "frequenz-repo-config[extra-lint-examples] == 0.10.0", ] dev = [ "frequenz-api-test[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]", diff --git a/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml index b01b3021..454088dc 100644 --- a/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml +++ b/tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml @@ -5,7 +5,7 @@ requires = [ "setuptools == 70.1.1", "setuptools_scm[toml] == 8.1.0", - "frequenz-repo-config[app] == 0.9.2", + "frequenz-repo-config[app] == 0.10.0", ] build-backend = "setuptools.build_meta" @@ -59,7 +59,7 @@ dev-mkdocs = [ "mkdocs-material == 9.5.27", "mkdocstrings[python] == 0.25.1", "mkdocstrings-python == 1.10.5", - "frequenz-repo-config[app] == 0.9.2", + "frequenz-repo-config[app] == 0.10.0", ] dev-mypy = [ "mypy == 1.9.0", @@ -69,7 +69,7 @@ dev-mypy = [ ] dev-noxfile = [ "nox == 2024.4.15", - "frequenz-repo-config[app] == 0.9.2", + "frequenz-repo-config[app] == 0.10.0", ] dev-pylint = [ # dev-pytest already defines a dependency to pylint because of the examples @@ -79,7 +79,7 @@ dev-pylint = [ dev-pytest = [ "pytest == 8.2.2", "pylint == 3.2.5", # We need this to check for the examples - "frequenz-repo-config[extra-lint-examples] == 0.9.2", + "frequenz-repo-config[extra-lint-examples] == 0.10.0", "pytest-mock == 3.14.0", "pytest-asyncio == 0.23.7", "async-solipsism == 0.6", diff --git a/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml index b0f924f2..85bfa251 100644 --- a/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml +++ b/tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml @@ -5,7 +5,7 @@ requires = [ "setuptools == 70.1.1", "setuptools_scm[toml] == 8.1.0", - "frequenz-repo-config[lib] == 0.9.2", + "frequenz-repo-config[lib] == 0.10.0", ] build-backend = "setuptools.build_meta" @@ -56,7 +56,7 @@ dev-mkdocs = [ "mkdocs-material == 9.5.27", "mkdocstrings[python] == 0.25.1", "mkdocstrings-python == 1.10.5", - "frequenz-repo-config[lib] == 0.9.2", + "frequenz-repo-config[lib] == 0.10.0", ] dev-mypy = [ "mypy == 1.9.0", @@ -66,7 +66,7 @@ dev-mypy = [ ] dev-noxfile = [ "nox == 2024.4.15", - "frequenz-repo-config[lib] == 0.9.2", + "frequenz-repo-config[lib] == 0.10.0", ] dev-pylint = [ # dev-pytest already defines a dependency to pylint because of the examples @@ -76,7 +76,7 @@ dev-pylint = [ dev-pytest = [ "pytest == 8.2.2", "pylint == 3.2.5", # We need this to check for the examples - "frequenz-repo-config[extra-lint-examples] == 0.9.2", + "frequenz-repo-config[extra-lint-examples] == 0.10.0", "pytest-mock == 3.14.0", "pytest-asyncio == 0.23.7", "async-solipsism == 0.6", diff --git a/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml b/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml index d542c170..b481d163 100644 --- a/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml +++ b/tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml @@ -5,7 +5,7 @@ requires = [ "setuptools == 70.1.1", "setuptools_scm[toml] == 8.1.0", - "frequenz-repo-config[model] == 0.9.2", + "frequenz-repo-config[model] == 0.10.0", ] build-backend = "setuptools.build_meta" @@ -60,7 +60,7 @@ dev-mkdocs = [ "mkdocs-material == 9.5.27", "mkdocstrings[python] == 0.25.1", "mkdocstrings-python == 1.10.5", - "frequenz-repo-config[model] == 0.9.2", + "frequenz-repo-config[model] == 0.10.0", ] dev-mypy = [ "mypy == 1.9.0", @@ -70,7 +70,7 @@ dev-mypy = [ ] dev-noxfile = [ "nox == 2024.4.15", - "frequenz-repo-config[model] == 0.9.2", + "frequenz-repo-config[model] == 0.10.0", ] dev-pylint = [ # dev-pytest already defines a dependency to pylint because of the examples @@ -80,7 +80,7 @@ dev-pylint = [ dev-pytest = [ "pytest == 8.2.2", "pylint == 3.2.5", # We need this to check for the examples - "frequenz-repo-config[extra-lint-examples] == 0.9.2", + "frequenz-repo-config[extra-lint-examples] == 0.10.0", "pytest-mock == 3.14.0", "pytest-asyncio == 0.23.7", "async-solipsism == 0.6",