Skip to content

Commit 8a4e067

Browse files
authored
Prepare for release v0.14.0 (#490)
Bump the version in the templates and clean up the release notes.
2 parents 3d86e08 + 73dc4ef commit 8a4e067

File tree

7 files changed

+28
-38
lines changed

7 files changed

+28
-38
lines changed

RELEASE_NOTES.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This release adds a new workflow for Dependabot auto-merge and updates mkdocstrings to v2.
66

77
## Upgrading
88

9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10-
119
### Cookiecutter template
1210

1311
All upgrading should be done via the migration script or regenerating the templates.
@@ -16,29 +14,21 @@ All upgrading should be done via the migration script or regenerating the templa
1614
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.14/cookiecutter/migrate.py | python3
1715
```
1816

19-
But you might still need to adapt your code:
20-
21-
<!-- Here upgrade steps for cookiecutter specifically -->
17+
But you might still need to adapt your code, just have a look at the script output for further instructions.
2218

2319
## New Features
2420

2521
* `mkdocsstrings-python` v2 is now supported.
2622

2723
### Cookiecutter template
2824

29-
- New warning ignores for protobuf gencode versions in pytest.
30-
- mkdocstrings: Updated the deprecated `import` config key to `inventories` in `mkdocs.yml`.
3125
- Dependencies have been updated.
26+
- New warning ignores for protobuf gencode versions in pytest.
3227
- Added Dependabot auto-merge workflow using `frequenz-floss/dependabot-auto-approve` action.
33-
- Migration script now creates auto-merge workflow and disables CODEOWNERS review requirement via GitHub API.
34-
- The `import` key in `mkdocs.yml` under `mkdocstrings` has to be renamed to `inventories`.
35-
- The `paths` key in `mkdocs.yml` under `mkdocstrings` has to be moved from the `options` key to the `python` key.
3628

3729
## Bug Fixes
3830

39-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
40-
4131
### Cookiecutter template
4232

4333
- mkdocstrings: Move `paths` key to the right section in `mkdocs.yml`.
44-
- Migration script: Fix invalid YAML syntax in Dependabot workflow template.
34+
- Fix invalid YAML syntax in Dependabot workflow template.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 75.8.0",
77
"setuptools_scm[toml] == 8.1.0",
8-
"frequenz-repo-config[{{cookiecutter.type}}] == 0.13.1",
8+
"frequenz-repo-config[{{cookiecutter.type}}] == 0.14.0",
99
{%- if cookiecutter.type == "api" %}
1010
# We need to pin the protobuf, grpcio and grpcio-tools dependencies to make
1111
# sure the code is generated using the minimum supported versions, as older
@@ -101,7 +101,7 @@ dev-mkdocs = [
101101
"mkdocs-material == 9.6.18",
102102
"mkdocstrings[python] == 1.0.0",
103103
"mkdocstrings-python == 2.0.1",
104-
"frequenz-repo-config[{{cookiecutter.type}}] == 0.13.1",
104+
"frequenz-repo-config[{{cookiecutter.type}}] == 0.14.0",
105105
]
106106
dev-mypy = [
107107
"mypy == 1.9.0",
@@ -114,7 +114,7 @@ dev-mypy = [
114114
]
115115
dev-noxfile = [
116116
"nox == 2025.5.1",
117-
"frequenz-repo-config[{{cookiecutter.type}}] == 0.13.1",
117+
"frequenz-repo-config[{{cookiecutter.type}}] == 0.14.0",
118118
]
119119
dev-pylint = [
120120
# dev-pytest already defines a dependency to pylint because of the examples
@@ -124,7 +124,7 @@ dev-pylint = [
124124
dev-pytest = [
125125
"pytest == 8.4.1",
126126
"pylint == 3.3.8", # We need this to check for the examples
127-
"frequenz-repo-config[extra-lint-examples] == 0.13.1",
127+
"frequenz-repo-config[extra-lint-examples] == 0.14.0",
128128
{%- if cookiecutter.type != "api" %}
129129
"pytest-mock == 3.14.0",
130130
"pytest-asyncio == 1.1.0",

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 75.8.0",
77
"setuptools_scm[toml] == 8.1.0",
8-
"frequenz-repo-config[actor] == 0.13.1",
8+
"frequenz-repo-config[actor] == 0.14.0",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -60,7 +60,7 @@ dev-mkdocs = [
6060
"mkdocs-material == 9.6.18",
6161
"mkdocstrings[python] == 1.0.0",
6262
"mkdocstrings-python == 2.0.1",
63-
"frequenz-repo-config[actor] == 0.13.1",
63+
"frequenz-repo-config[actor] == 0.14.0",
6464
]
6565
dev-mypy = [
6666
"mypy == 1.9.0",
@@ -70,7 +70,7 @@ dev-mypy = [
7070
]
7171
dev-noxfile = [
7272
"nox == 2025.5.1",
73-
"frequenz-repo-config[actor] == 0.13.1",
73+
"frequenz-repo-config[actor] == 0.14.0",
7474
]
7575
dev-pylint = [
7676
# dev-pytest already defines a dependency to pylint because of the examples
@@ -80,7 +80,7 @@ dev-pylint = [
8080
dev-pytest = [
8181
"pytest == 8.4.1",
8282
"pylint == 3.3.8", # We need this to check for the examples
83-
"frequenz-repo-config[extra-lint-examples] == 0.13.1",
83+
"frequenz-repo-config[extra-lint-examples] == 0.14.0",
8484
"pytest-mock == 3.14.0",
8585
"pytest-asyncio == 1.1.0",
8686
"async-solipsism == 0.8",

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 75.8.0",
77
"setuptools_scm[toml] == 8.1.0",
8-
"frequenz-repo-config[api] == 0.13.1",
8+
"frequenz-repo-config[api] == 0.14.0",
99
# We need to pin the protobuf, grpcio and grpcio-tools dependencies to make
1010
# sure the code is generated using the minimum supported versions, as older
1111
# versions can't work with code that was generated with newer versions.
@@ -71,7 +71,7 @@ dev-mkdocs = [
7171
"mkdocs-material == 9.6.18",
7272
"mkdocstrings[python] == 1.0.0",
7373
"mkdocstrings-python == 2.0.1",
74-
"frequenz-repo-config[api] == 0.13.1",
74+
"frequenz-repo-config[api] == 0.14.0",
7575
]
7676
dev-mypy = [
7777
"mypy == 1.9.0",
@@ -82,7 +82,7 @@ dev-mypy = [
8282
]
8383
dev-noxfile = [
8484
"nox == 2025.5.1",
85-
"frequenz-repo-config[api] == 0.13.1",
85+
"frequenz-repo-config[api] == 0.14.0",
8686
]
8787
dev-pylint = [
8888
# dev-pytest already defines a dependency to pylint because of the examples
@@ -92,7 +92,7 @@ dev-pylint = [
9292
dev-pytest = [
9393
"pytest == 8.4.1",
9494
"pylint == 3.3.8", # We need this to check for the examples
95-
"frequenz-repo-config[extra-lint-examples] == 0.13.1",
95+
"frequenz-repo-config[extra-lint-examples] == 0.14.0",
9696
]
9797
dev = [
9898
"frequenz-api-test[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 75.8.0",
77
"setuptools_scm[toml] == 8.1.0",
8-
"frequenz-repo-config[app] == 0.13.1",
8+
"frequenz-repo-config[app] == 0.14.0",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -59,7 +59,7 @@ dev-mkdocs = [
5959
"mkdocs-material == 9.6.18",
6060
"mkdocstrings[python] == 1.0.0",
6161
"mkdocstrings-python == 2.0.1",
62-
"frequenz-repo-config[app] == 0.13.1",
62+
"frequenz-repo-config[app] == 0.14.0",
6363
]
6464
dev-mypy = [
6565
"mypy == 1.9.0",
@@ -69,7 +69,7 @@ dev-mypy = [
6969
]
7070
dev-noxfile = [
7171
"nox == 2025.5.1",
72-
"frequenz-repo-config[app] == 0.13.1",
72+
"frequenz-repo-config[app] == 0.14.0",
7373
]
7474
dev-pylint = [
7575
# dev-pytest already defines a dependency to pylint because of the examples
@@ -79,7 +79,7 @@ dev-pylint = [
7979
dev-pytest = [
8080
"pytest == 8.4.1",
8181
"pylint == 3.3.8", # We need this to check for the examples
82-
"frequenz-repo-config[extra-lint-examples] == 0.13.1",
82+
"frequenz-repo-config[extra-lint-examples] == 0.14.0",
8383
"pytest-mock == 3.14.0",
8484
"pytest-asyncio == 1.1.0",
8585
"async-solipsism == 0.8",

tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 75.8.0",
77
"setuptools_scm[toml] == 8.1.0",
8-
"frequenz-repo-config[lib] == 0.13.1",
8+
"frequenz-repo-config[lib] == 0.14.0",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -56,7 +56,7 @@ dev-mkdocs = [
5656
"mkdocs-material == 9.6.18",
5757
"mkdocstrings[python] == 1.0.0",
5858
"mkdocstrings-python == 2.0.1",
59-
"frequenz-repo-config[lib] == 0.13.1",
59+
"frequenz-repo-config[lib] == 0.14.0",
6060
]
6161
dev-mypy = [
6262
"mypy == 1.9.0",
@@ -66,7 +66,7 @@ dev-mypy = [
6666
]
6767
dev-noxfile = [
6868
"nox == 2025.5.1",
69-
"frequenz-repo-config[lib] == 0.13.1",
69+
"frequenz-repo-config[lib] == 0.14.0",
7070
]
7171
dev-pylint = [
7272
# dev-pytest already defines a dependency to pylint because of the examples
@@ -76,7 +76,7 @@ dev-pylint = [
7676
dev-pytest = [
7777
"pytest == 8.4.1",
7878
"pylint == 3.3.8", # We need this to check for the examples
79-
"frequenz-repo-config[extra-lint-examples] == 0.13.1",
79+
"frequenz-repo-config[extra-lint-examples] == 0.14.0",
8080
"pytest-mock == 3.14.0",
8181
"pytest-asyncio == 1.1.0",
8282
"async-solipsism == 0.8",

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
requires = [
66
"setuptools == 75.8.0",
77
"setuptools_scm[toml] == 8.1.0",
8-
"frequenz-repo-config[model] == 0.13.1",
8+
"frequenz-repo-config[model] == 0.14.0",
99
]
1010
build-backend = "setuptools.build_meta"
1111

@@ -60,7 +60,7 @@ dev-mkdocs = [
6060
"mkdocs-material == 9.6.18",
6161
"mkdocstrings[python] == 1.0.0",
6262
"mkdocstrings-python == 2.0.1",
63-
"frequenz-repo-config[model] == 0.13.1",
63+
"frequenz-repo-config[model] == 0.14.0",
6464
]
6565
dev-mypy = [
6666
"mypy == 1.9.0",
@@ -70,7 +70,7 @@ dev-mypy = [
7070
]
7171
dev-noxfile = [
7272
"nox == 2025.5.1",
73-
"frequenz-repo-config[model] == 0.13.1",
73+
"frequenz-repo-config[model] == 0.14.0",
7474
]
7575
dev-pylint = [
7676
# dev-pytest already defines a dependency to pylint because of the examples
@@ -80,7 +80,7 @@ dev-pylint = [
8080
dev-pytest = [
8181
"pytest == 8.4.1",
8282
"pylint == 3.3.8", # We need this to check for the examples
83-
"frequenz-repo-config[extra-lint-examples] == 0.13.1",
83+
"frequenz-repo-config[extra-lint-examples] == 0.14.0",
8484
"pytest-mock == 3.14.0",
8585
"pytest-asyncio == 1.1.0",
8686
"async-solipsism == 0.8",

0 commit comments

Comments
 (0)