Skip to content

Prepare for release v0.14.0 #490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
llucax merged 1 commit into from
Jan 14, 2026
Merged

Prepare for release v0.14.0 #490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 4 additions & 14 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@

## Summary

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

## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

### Cookiecutter template

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

But you might still need to adapt your code:

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

## New Features

* `mkdocsstrings-python` v2 is now supported.

### Cookiecutter template

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

## Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

### Cookiecutter template

- mkdocstrings: Move `paths` key to the right section in `mkdocs.yml`.
- Migration script: Fix invalid YAML syntax in Dependabot workflow template.
- Fix invalid YAML syntax in Dependabot workflow template.
8 changes: 4 additions & 4 deletions cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 75.8.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.13.1",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.14.0",
{%- if cookiecutter.type == "api" %}
# We need to pin the protobuf, grpcio and grpcio-tools dependencies to make
# sure the code is generated using the minimum supported versions, as older
Expand Down Expand Up @@ -101,7 +101,7 @@ dev-mkdocs = [
"mkdocs-material == 9.6.18",
"mkdocstrings[python] == 1.0.0",
"mkdocstrings-python == 2.0.1",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.13.1",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.14.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -114,7 +114,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2025.5.1",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.13.1",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.14.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -124,7 +124,7 @@ dev-pylint = [
dev-pytest = [
"pytest == 8.4.1",
"pylint == 3.3.8", # We need this to check for the examples
"frequenz-repo-config[extra-lint-examples] == 0.13.1",
"frequenz-repo-config[extra-lint-examples] == 0.14.0",
{%- if cookiecutter.type != "api" %}
"pytest-mock == 3.14.0",
"pytest-asyncio == 1.1.0",
Expand Down
8 changes: 4 additions & 4 deletions ..._golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 75.8.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[actor] == 0.13.1",
"frequenz-repo-config[actor] == 0.14.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -60,7 +60,7 @@ dev-mkdocs = [
"mkdocs-material == 9.6.18",
"mkdocstrings[python] == 1.0.0",
"mkdocstrings-python == 2.0.1",
"frequenz-repo-config[actor] == 0.13.1",
"frequenz-repo-config[actor] == 0.14.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -70,7 +70,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2025.5.1",
"frequenz-repo-config[actor] == 0.13.1",
"frequenz-repo-config[actor] == 0.14.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -80,7 +80,7 @@ dev-pylint = [
dev-pytest = [
"pytest == 8.4.1",
"pylint == 3.3.8", # We need this to check for the examples
"frequenz-repo-config[extra-lint-examples] == 0.13.1",
"frequenz-repo-config[extra-lint-examples] == 0.14.0",
"pytest-mock == 3.14.0",
"pytest-asyncio == 1.1.0",
"async-solipsism == 0.8",
Expand Down
8 changes: 4 additions & 4 deletions tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 75.8.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[api] == 0.13.1",
"frequenz-repo-config[api] == 0.14.0",
# We need to pin the protobuf, grpcio and grpcio-tools dependencies to make
# sure the code is generated using the minimum supported versions, as older
# versions can't work with code that was generated with newer versions.
Expand Down Expand Up @@ -71,7 +71,7 @@ dev-mkdocs = [
"mkdocs-material == 9.6.18",
"mkdocstrings[python] == 1.0.0",
"mkdocstrings-python == 2.0.1",
"frequenz-repo-config[api] == 0.13.1",
"frequenz-repo-config[api] == 0.14.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -82,7 +82,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2025.5.1",
"frequenz-repo-config[api] == 0.13.1",
"frequenz-repo-config[api] == 0.14.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -92,7 +92,7 @@ dev-pylint = [
dev-pytest = [
"pytest == 8.4.1",
"pylint == 3.3.8", # We need this to check for the examples
"frequenz-repo-config[extra-lint-examples] == 0.13.1",
"frequenz-repo-config[extra-lint-examples] == 0.14.0",
]
dev = [
"frequenz-api-test[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
Expand Down
8 changes: 4 additions & 4 deletions tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 75.8.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[app] == 0.13.1",
"frequenz-repo-config[app] == 0.14.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -59,7 +59,7 @@ dev-mkdocs = [
"mkdocs-material == 9.6.18",
"mkdocstrings[python] == 1.0.0",
"mkdocstrings-python == 2.0.1",
"frequenz-repo-config[app] == 0.13.1",
"frequenz-repo-config[app] == 0.14.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -69,7 +69,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2025.5.1",
"frequenz-repo-config[app] == 0.13.1",
"frequenz-repo-config[app] == 0.14.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -79,7 +79,7 @@ dev-pylint = [
dev-pytest = [
"pytest == 8.4.1",
"pylint == 3.3.8", # We need this to check for the examples
"frequenz-repo-config[extra-lint-examples] == 0.13.1",
"frequenz-repo-config[extra-lint-examples] == 0.14.0",
"pytest-mock == 3.14.0",
"pytest-asyncio == 1.1.0",
"async-solipsism == 0.8",
Expand Down
8 changes: 4 additions & 4 deletions ...s_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 75.8.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[lib] == 0.13.1",
"frequenz-repo-config[lib] == 0.14.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -56,7 +56,7 @@ dev-mkdocs = [
"mkdocs-material == 9.6.18",
"mkdocstrings[python] == 1.0.0",
"mkdocstrings-python == 2.0.1",
"frequenz-repo-config[lib] == 0.13.1",
"frequenz-repo-config[lib] == 0.14.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -66,7 +66,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2025.5.1",
"frequenz-repo-config[lib] == 0.13.1",
"frequenz-repo-config[lib] == 0.14.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -76,7 +76,7 @@ dev-pylint = [
dev-pytest = [
"pytest == 8.4.1",
"pylint == 3.3.8", # We need this to check for the examples
"frequenz-repo-config[extra-lint-examples] == 0.13.1",
"frequenz-repo-config[extra-lint-examples] == 0.14.0",
"pytest-mock == 3.14.0",
"pytest-asyncio == 1.1.0",
"async-solipsism == 0.8",
Expand Down
8 changes: 4 additions & 4 deletions ..._golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
requires = [
"setuptools == 75.8.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[model] == 0.13.1",
"frequenz-repo-config[model] == 0.14.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -60,7 +60,7 @@ dev-mkdocs = [
"mkdocs-material == 9.6.18",
"mkdocstrings[python] == 1.0.0",
"mkdocstrings-python == 2.0.1",
"frequenz-repo-config[model] == 0.13.1",
"frequenz-repo-config[model] == 0.14.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -70,7 +70,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2025.5.1",
"frequenz-repo-config[model] == 0.13.1",
"frequenz-repo-config[model] == 0.14.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -80,7 +80,7 @@ dev-pylint = [
dev-pytest = [
"pytest == 8.4.1",
"pylint == 3.3.8", # We need this to check for the examples
"frequenz-repo-config[extra-lint-examples] == 0.13.1",
"frequenz-repo-config[extra-lint-examples] == 0.14.0",
"pytest-mock == 3.14.0",
"pytest-asyncio == 1.1.0",
"async-solipsism == 0.8",
Expand Down