Releases: frequenz-floss/frequenz-repo-config-python
v0.14.0
Frequenz Repository Configuration Release Notes
Summary
This release adds a new workflow for Dependabot auto-merge and updates mkdocstrings to v2.
Upgrading
Cookiecutter template
All upgrading should be done via the migration script or regenerating the templates.
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.14.0/cookiecutter/migrate.py | python3But you might still need to adapt your code, just have a look at the script output for further instructions.
New Features
mkdocsstrings-pythonv2 is now supported.
Cookiecutter template
- Dependencies have been updated.
- New warning ignores for protobuf gencode versions in pytest.
- Added Dependabot auto-merge workflow using
frequenz-floss/dependabot-auto-approveaction.
Bug Fixes
Cookiecutter template
- mkdocstrings: Move
pathskey to the right section inmkdocs.yml. - Fix invalid YAML syntax in Dependabot workflow template.
What's Changed
- Bump types-pyyaml from 6.0.12.20250402 to 6.0.12.20250516 by @dependabot[bot] in #410
- Bump the patch group with 2 updates by @dependabot[bot] in #408
- Bump the minor group with 2 updates by @dependabot[bot] in #409
- Improve filtering of warnings in pytest by @llucax in #411
- Fix mkdocsstrings config by @llucax in #412
- Merge v0.13.x into v0.x.x by @llucax in #420
- Bump the patch group with 3 updates by @dependabot[bot] in #424
- Bump the minor group with 2 updates by @dependabot[bot] in #423
- Update templates dependencies by @llucax in #431
- Bump types-markdown from 3.8.0.20250415 to 3.8.0.20250708 by @dependabot[bot] in #430
- Bump mypy from 1.16.1 to 1.17.1 in the minor group by @dependabot[bot] in #428
- Bump the mkdocstrings group across 1 directory with 2 updates by @dependabot[bot] in #432
- Bump the patch group across 1 directory with 3 updates by @dependabot[bot] in #433
- Bump the compatible group with 2 updates by @dependabot[bot] in #426
- Bump mkdocstrings-python from 1.17.0 to 1.18.2 in the mkdocstrings group by @dependabot[bot] in #440
- Bump types-pyyaml from 6.0.12.20250516 to 6.0.12.20250822 by @dependabot[bot] in #439
- Bump actions/download-artifact from 4 to 5 in the artifacts group by @dependabot[bot] in #438
- Bump types-colorama from 0.4.15.20240311 to 0.4.15.20250801 by @dependabot[bot] in #436
- Bump actions/checkout from 4 to 5 by @dependabot[bot] in #437
- Bump pydoclint from 0.6.6 to 0.6.11 by @dependabot[bot] in #434
- Bump setuptools-scm[toml] from 8.3.1 to 9.2.0 by @dependabot[bot] in #435
- Bump the minor group with 5 updates by @dependabot[bot] in #452
- Bump types-pyyaml from 6.0.12.20250822 to 6.0.12.20250915 by @dependabot[bot] in #454
- Bump the patch group across 1 directory with 4 updates by @dependabot[bot] in #455
- Bump actions/labeler from 5.0.0 to 6.0.1 by @dependabot[bot] in #450
- Bump pydoclint from 0.6.11 to 0.7.3 by @dependabot[bot] in #453
- Support pylint 4 by @Marenz in #457
- Bump actions/upload-artifact from 4 to 5 by @dependabot[bot] in #459
- Bump isort from 6.0.1 to 7.0.0 by @dependabot[bot] in #464
- Bump nox from 2025.5.1 to 2025.10.16 in the minor group by @dependabot[bot] in #462
- Add Dependabot auto-merge workflow and migration script by @Marenz in #466
- Fix invalid YAML formatting in Dependabot workflow template by @Marenz in #469
- Bump actions/checkout from 5 to 6 by @dependabot[bot] in #476
- Bump the patch group across 1 directory with 3 updates by @dependabot[bot] in #478
- Add support for
mkdocstrings-pythonv2 by @llucax in #481 - Merge v0.13.8 into v0.x.x by @llucax in #480
- Bump the minor group with 7 updates by @dependabot[bot] in #488
- Bump pytest from 9.0.1 to 9.0.2 in the patch group by @dependabot[bot] in #487
- Bump frequenz-floss/gh-action-nox from 1.0.1 to 1.1.0 in the compatible group by @dependabot[bot] in #475
- Bump pydoclint from 0.7.3 to 0.8.3 by @dependabot[bot] in #477
- Bump actions/download-artifact from 5 to 6 by @dependabot[bot] in #460
- Prepare for release v0.14.0 by @llucax in #490
- Update mypy-protobuf requirement from <4,>=3.0.0 to >=3.0.0,<5 by @dependabot[bot] in #489
Full Changelog: v0.13.8...v0.14.0
v0.13.8
Frequenz Repository Configuration Release Notes
New Features
mkdocs-gen-filesv0.6 is now supported.
What's Changed
Full Changelog: v0.13.7...v0.13.8
v0.13.7
Frequenz Repository Configuration Release Notes
New Features
- Pytest v9.x is now supported.
What's Changed
Full Changelog: v0.13.6...v0.13.7
v0.13.6
v0.13.5
Frequenz Repository Configuration Release Notes
Bug Fixes
-
Fixed some typos in the docs.
-
Fixed wrong comparison for
mikeversions when versions were equal. -
Fixed version regex escaping of
.. This means that a version like v0x1e1 were accepted as valid semver versions. Now this version is not considered a semver version anymore. -
setuptools.grpc_tools: Fix wrong passing of include paths when passed via:- Command-line: Now extra white-spaces and empty strings are removed, before they were passed to
protoc -I. pyproject.toml: Now an empty array/list can be passed to override the default paths, before this resulted in an empty string being passed toprotoc -I.
- Command-line: Now extra white-spaces and empty strings are removed, before they were passed to
What's Changed
- Clear release notes by @llucax in #405
- Fix typos in documentation by @llucax in #416
- setuptools: Fix passing empty include paths by @llucax in #418
- Fix missing comparison for equal versions by @llucax in #415
Full Changelog: v0.13.4...v0.13.5
v0.13.4
Frequenz Repository Configuration Release Notes
Summary
This release just widens the setuptools dependency to allow for version 80.x.
What's Changed
- Clear release notes by @llucax in #393
- Widen setuptools upper bound to < 81 by @llucax in #401
- Bump setuptools from 79.0.0 to 80.1.0 by @dependabot in #400
- Bump pydoclint from 0.6.4 to 0.6.6 by @dependabot in #397
- Bump types-pyyaml from 6.0.12.20250326 to 6.0.12.20250402 by @dependabot in #398
- Update types-setuptools requirement from <80,>=67.6.0 to >=67.6.0,<81 by @dependabot in #399
- Bump the patch group across 1 directory with 4 updates by @dependabot in #402
- Bump the minor group with 4 updates by @dependabot in #404
Full Changelog: v0.13.3...v0.13.4
v0.13.3
v0.13.2
Bug Fixes
- Fix
setuptoolsdependency range so it is possible to use the latestsetuptoolsversion.
What's Changed
- Bump types-markdown from 3.7.0.20241204 to 3.7.0.20250322 by @dependabot in #376
- Clear release notes by @llucax in #381
- Bump pydoclint from 0.6.0 to 0.6.4 by @dependabot in #385
- Update types-setuptools requirement from <78,>=67.6.0 to >=67.6.0,<79 by @dependabot in #384
- Bump the patch group with 2 updates by @dependabot in #382
- Bump the minor group with 3 updates by @dependabot in #386
- Fix setuptools dependency by @llucax in #387
- Prepare release notes for v0.13.2 by @llucax in #388
Full Changelog: v0.13.1...v0.13.2
v0.13.1
Frequenz Repository Configuration Release Notes
Bug Fixes
Cookiecutter template
- Fix the repo-config version number that was outdated.
What's Changed
- Fix the outdated version number in the template by @llucax in #380
- Clear release notes and migration script by @llucax in #378
- Bump the patch group across 1 directory with 6 updates by @dependabot in #379
Full Changelog: v0.13.0...v0.13.1
v0.13.0
Frequenz Repository Configuration Release Notes
Summary
This release improves dependabot groups, so it is less likely that breaking updates are grouped with non-breaking updates and upgrades the GitHub workflows to use more actions, run PR checks faster and use Ubuntu 24.04 instead of 20.04.
Upgrading
Cookiecutter template
- Branch protection rule Protect version branches was updated, please re-import it following the instructions.
Important
For api projects make sure to require the Check proto files with protolint status check too, which is not included by the provided ruleset by default.
All other upgrading should be done via the migration script or regenerating the templates.
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.13.0/cookiecutter/migrate.py | python3But you might still need to adapt your code:
- The new workflows will test using Python 3.12 too, if your code is not compatible with it, you might need to fix it, or you can just remove the Python 3.12 from the test matrix if you need a quick fix. For example, the
typing-extensionlibrary is compatible with Python 3.12 from version 4.6.0, so you might need to upgrade it if you are using it. - Check the new dependabot configuration file if you customized the dependabot configuration for the
pipecosystem. - Add exclusions for any other dependency you have at v0.x.x or that breaks frequently, so dependabot PRs are easy to merge.
New Features
Cookiecutter template
-
Dependabot config now uses a new grouping that should make upgrades more smooth.
- We group patch updates as they should always work.
- We also group minor updates, as it works too for most libraries, typically except libraries that don't have a stable release yet (v0.x.x branch), so we make some exceptions for them.
- Major updates and dependencies excluded by the above groups are still managed, but they'll create one PR per dependency, as breakage is expected, so it might need manual intervention.
- Finally, we group some dependencies that are related to each other, and usually needs to be updated together.
-
The GitHub workflows is now split into PRs and CI workflows.
These new workflows also start using a new reusable
gh-action-nox, native arm runners and Ubuntu 24.04, as Ubuntu 20.04 will be removed from GitHub runners by April's 1st. Python 3.12 is also added to the test matrix.The PR action is more lightweight, and only tests with one matrix (the most widely used), so PRs can be tested more quickly.
The push workflow does a more intense testing with all matrix combinations. This also runs for the merge queue, so before PRs are actually merged the tests will run for the complete matrix.
- The Python
Protect version branchesbranch protection rule now request review to Copilot by default.
What's Changed
- Clear release notes and migration script by @llucax in #362
- Bump nox from 2024.10.9 to 2025.2.9 by @dependabot in #364
- Exclude frequenz-repo-config from dependabot grouping by @llucax in #368
- Update types-setuptools requirement from <76,>=67.6.0 to >=67.6.0,<78 by @dependabot in #374
- Bump setuptools from 75.8.0 to 78.1.0 by @dependabot in #377
- Bump the mkdocstrings group with 2 updates by @dependabot in #372
- Bump types-pyyaml from 6.0.12.20241230 to 6.0.12.20250326 by @dependabot in #373
- Use new split workflow Ubuntu 24.04 in workflows by @llucax in #369
Full Changelog: v0.12.3...v0.13.0