Frequenz-repo-config

"mkdocs-gen-files == 0.5.0",
"mkdocs-literate-nav == 0.6.1",
"mkdocs-material == 9.4.7",


If that's not the case, your `pyproject.toml` and/or `mkdocs.yml` files might have been diverged from the generated files and updated in a way that is not compatible with the upgrade. In that case you'll have to fix it manually or re-generate the templates.

Bug Fixes

- `cli.version.mike.info`: Don't fail if the version can't be determined, just emit a warning and exit succesfully.

Cookiecutter template

- CI: The documentation publishing job will not fail if the version for `mike` can't be determined, it will just emit a warning and skip the publishing of the documentation website.


What's Changed
* Add support and bump to `mike` 2.0.0 by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/174


**Full Changelog**: https://github.com/frequenz-floss/frequenz-repo-config-python/compare/v0.7.4...v0.7.5

Frequenz Repository Configuration Release Notes

Summary

This version accumulates a few improvements, and bumps the dependency of setuptools to use v75, which is compatible with PEP625, which is necessary to be able to keep uploading to PyPI, so you should upgrade to this version as soon as possible.

The migration script was also rewritten in Python, so it should be more compatible with different OSes.

Upgrading

- The `frequenz.repo.config.github.abort()` function now takes most arguments as keyword-only arguments.
- The *Queue PRs for v0.x.x* GitHub ruleset was renamed to *Queue PRs for the default branch* and now targets the default branch. It also only have the merge queue restriction, all other restrictions were removed as they are already present in the *Protect version branches* ruleset. You might want to re-import this ruleset to your repositories.

New Features

* Added a new GitHub branch ruleset for Rust projects.

Cookiecutter template

* Group GitHub Actions dependabot updates.
* API projects don't include the `google-common-protos` dependency by default.
* API projects updated the `grpcio` dependency to `1.66.1`.
* API projects updated the `frequenz-api-common` dependency to `0.6`.
* Bump most of the dependencies.
* Change `edit_uri` default branch to v0.x.x in mkdocs.yml.
* Added a new default option `asyncio_default_fixture_loop_scope = "function"` for `pytest-asyncio` as not providing a value is deprecated.
* The migration script is now written in Python, so it should be (hopefully) more compatible with different OSes.
* Disable more `pylint` checks that are also checked by `mypy` to avoid false positives.
* Remove the redundant `--platform` from the testing dockerfile.

Bug Fixes

* Sybil now parses the `__init__.py` file as well. Previously it was disabled due to an upstream bug.


What's Changed
* Fix TODO typos for workflows/release-notes-checks by daniel-zullo-frequenz in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/291
* Reset release notes and migration script for the next release by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/292
* Group dependabot updates for GitHub Actions by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/293
* Bump types-pyyaml from 6.0.12.20240311 to 6.0.12.20240724 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/297
* Update types-setuptools requirement from <71,>=67.6.0 to >=67.6.0,<72 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/296
* Update setuptools requirement from <71,>=67.6.0 to >=67.6.0,<72 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/295
* Bump the required group with 5 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/294
* Bump the required group with 4 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/300
* Update setuptools requirement from <72,>=67.6.0 to >=67.6.0,<73 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/301
* Pin protobuf related dependencies by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/309
* Bump the required group across 1 directory with 10 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/310
* Bump types-pyyaml from 6.0.12.20240724 to 6.0.12.20240808 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/307
* Update setuptools requirement from <73,>=67.6.0 to >=67.6.0,<75 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/306
* Fix the labeler configuration example by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/304
* Update types-setuptools requirement from <72,>=67.6.0 to >=67.6.0,<75 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/308
* Update setuptools requirement from <75,>=67.6.0 to >=67.6.0,<76 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/314
* Bump the required group with 4 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/312
* Update sybil requirement from <7,>=6.1.1 to >=6.1.1,<9 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/315
* Change edit_uri default branch to v0.x.x in mkdocs.yml by cwasicki in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/311
* Update types-setuptools requirement from <75,>=67.6.0 to >=67.6.0,<76 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/313
* Bump types-pyyaml from 6.0.12.20240808 to 6.0.12.20240917 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/316
* Bump SDK dependency to 1.0.0rc901 by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/317
* Add `asyncio_default_fixture_loop_scope = "function"` option by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/318
* Add GitHub branch ruleset for Rust by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/320
* Sybil: Parse __init__ by Marenz in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/321
* Bump the required group with 7 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/322
* Bump the required group with 2 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/325
* Bump setuptools-scm[toml] from 7.1.0 to 8.1.0 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/326
* Update sybil requirement from <9,>=6.1.1 to >=6.1.1,<10 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/327
* Port the migration script to Python by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/329
* Disable more pylint checks that are also checked by mypy by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/330
* Bump dependencies in the template by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/331
* Remove the redundant `--platform` from the `Dockerfile` by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/332
* Prepare for the v0.11.0 release by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/333

New Contributors
* daniel-zullo-frequenz made their first contribution in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/291

**Full Changelog**: https://github.com/frequenz-floss/frequenz-repo-config-python/compare/v0.10.0...v0.11.0

Frequenz Repository Configuration Release Notes

Summary

This version accumulates a few improvements, and bumps the dependency of setuptools to use v75, which is compatible with PEP625, which is necessary to be able to keep uploading to PyPI, so you should upgrade to this version as soon as possible.

The migration script was also rewritten in Python, so it should be more compatible with different OSes.

Upgrading

- The `frequenz.repo.config.github.abort()` function now takes most arguments as keyword-only arguments.
- The *Queue PRs for v0.x.x* GitHub ruleset was renamed to *Queue PRs for the default branch* and now targets the default branch. It also only have the merge queue restriction, all other restrictions were removed as they are already present in the *Protect version branches* ruleset. You might want to re-import this ruleset to your repositories.

New Features

* Added a new GitHub branch ruleset for Rust projects.

Cookiecutter template

* Group GitHub Actions dependabot updates.
* API projects don't include the `google-common-protos` dependency by default.
* API projects updated the `grpcio` dependency to `1.66.1`.
* API projects updated the `frequenz-api-common` dependency to `0.6`.
* Bump most of the dependencies.
* Change `edit_uri` default branch to v0.x.x in mkdocs.yml.
* Added a new default option `asyncio_default_fixture_loop_scope = "function"` for `pytest-asyncio` as not providing a value is deprecated.
* The migration script is now written in Python, so it should be (hopefully) more compatible with different OSes.
* Disable more `pylint` checks that are also checked by `mypy` to avoid false positives.
* Remove the redundant `--platform` from the testing dockerfile.

Bug Fixes

* Sybil now parses the `__init__.py` file as well. Previously it was disabled due to an upstream bug.


What's Changed
* Fix TODO typos for workflows/release-notes-checks by daniel-zullo-frequenz in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/291
* Reset release notes and migration script for the next release by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/292
* Group dependabot updates for GitHub Actions by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/293
* Bump types-pyyaml from 6.0.12.20240311 to 6.0.12.20240724 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/297
* Update types-setuptools requirement from <71,>=67.6.0 to >=67.6.0,<72 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/296
* Update setuptools requirement from <71,>=67.6.0 to >=67.6.0,<72 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/295
* Bump the required group with 5 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/294
* Bump the required group with 4 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/300
* Update setuptools requirement from <72,>=67.6.0 to >=67.6.0,<73 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/301
* Pin protobuf related dependencies by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/309
* Bump the required group across 1 directory with 10 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/310
* Bump types-pyyaml from 6.0.12.20240724 to 6.0.12.20240808 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/307
* Update setuptools requirement from <73,>=67.6.0 to >=67.6.0,<75 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/306
* Fix the labeler configuration example by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/304
* Update types-setuptools requirement from <72,>=67.6.0 to >=67.6.0,<75 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/308
* Update setuptools requirement from <75,>=67.6.0 to >=67.6.0,<76 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/314
* Bump the required group with 4 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/312
* Update sybil requirement from <7,>=6.1.1 to >=6.1.1,<9 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/315
* Change edit_uri default branch to v0.x.x in mkdocs.yml by cwasicki in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/311
* Update types-setuptools requirement from <75,>=67.6.0 to >=67.6.0,<76 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/313
* Bump types-pyyaml from 6.0.12.20240808 to 6.0.12.20240917 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/316
* Bump SDK dependency to 1.0.0rc901 by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/317
* Add `asyncio_default_fixture_loop_scope = "function"` option by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/318
* Add GitHub branch ruleset for Rust by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/320
* Sybil: Parse __init__ by Marenz in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/321
* Bump the required group with 7 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/322
* Bump the required group with 2 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/325
* Bump setuptools-scm[toml] from 7.1.0 to 8.1.0 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/326
* Update sybil requirement from <9,>=6.1.1 to >=6.1.1,<10 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/327
* Port the migration script to Python by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/329
* Disable more pylint checks that are also checked by mypy by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/330
* Bump dependencies in the template by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/331
* Remove the redundant `--platform` from the `Dockerfile` by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/332
* Prepare for the v0.11.0 release by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/333

New Contributors
* daniel-zullo-frequenz made their first contribution in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/291

**Full Changelog**: https://github.com/frequenz-floss/frequenz-repo-config-python/compare/v0.10.0...v0.11.0-rc1

Frequenz Repository Configuration Release Notes

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.

To run it, the simplest way is to fetch it from GitHub and run it directly:

console
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.10.0/cookiecutter/migrate.sh | sh


Make sure the version you want to migrate to is correct in the URL.

For jumping multiple versions you should run the script multiple times, once for each version.

And remember to follow any manual instructions for each run.

New Features

- A new GitHub ruleset is provided to configure the merge queue, so branch protection rules are not needed anymore.

Enhancements

- The generated docs now show the symbol type in the table of contents.

Cookiecutter template

- The `Markdown` dependency was bumped so we don't need to add a `type: ignore` due to incorrect type hints.
- The generated docs now show the symbol type in the table of contents.
- The dependecies were updated to the latest versions.
- Disabled some `pylint` checks that are already checked by other tools.
- The generated documentation now uses symlinks for aliases, which allows deep linking when using aliases too.

Bug Fixes

- The code example extractor relied on a bug in the upstream sybil project that was recently fixed, thus our code also needed to be fixed.

Cookiecutter template

- Fixed a bug where the pip cache post action fails in the CI workflow because of permissions issues.
- Make the `nox-cross-arch-all` job fail if any `nox-cross-arch` matrix job fails.
- Fix credentials not being passed to the `test-installation` job in the CI workflow.
- Make sure credentials are configured for all jobs that check out the repository in the CI workflow.
- Disable the new `check-class-attributes` check in pydoclint 0.5.3, as we use a different way to document class attributes.
- Fix permissions issues with the `release-notes-check` workflow when the repository Actions configuration is set up without full access.


What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/233
* Add a migration script by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/240
* Fix Markdown type:ignore by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/241
* mkdocs: Show symbol type in the ToC by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/244
* Configure the merge queue via a ruleset by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/242
* Bump dependencies by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/245
* Bump the required group across 1 directory with 6 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/248
* Make dependabot check for updates monthly on Wednesday by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/250
* Bump actions/setup-python from 4 to 5 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/254
* Bump actions/cache from 3 to 4 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/252
* Don't recursively scan for pyproject.toml when calculating the cache key by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/260
* Bump the required group across 1 directory with 3 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/259
* Fix CI failing with setuptools dependency missing by Marenz in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/258
* Pin sybil to < 6.1 by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/262
* Downgrade sybil to 6.0.3 by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/264
* Fail the nox-cross-arch-all job if any matrix job fails by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/261
* Bump actions/{up,down}load-artifact from 3 to 4 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/251
* Fix the Queue PRs for v0.x.x.json ruleset by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/263
* Fix the condition to run the `nox-cross-arch-all` job by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/265
* Fix the migration script by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/268
* Fix code example extractor relying on bug in sybil by Marenz in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/256
* Update types-setuptools requirement from <70,>=67.6.0 to >=67.6.0,<71 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/273
* Update setuptools requirement from <70,>=67.6.0 to >=67.6.0,<71 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/272
* Bump the required group with 7 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/271
* Disable some pylint checks that are checked by other tools by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/280
* mkdocs: Use symlink alias types by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/281
* Bump docker/build-push-action from 5 to 6 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/284
* Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/285
* Bump the required group with 8 updates by dependabot in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/283
* Fix credentials not passed or configured the CI workflow by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/286
* Disable the new `check-class-attributes` check in pydoclint 0.5.3 by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/288
* Prepare for the v0.10.0 release by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/290
* Add pull-requests read permission to the release-notes-check workflow by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/289

New Contributors
* dependabot made their first contribution in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/248

**Full Changelog**: https://github.com/frequenz-floss/frequenz-repo-config-python/compare/v0.9.1...v0.10.0

Frequenz Repository Configuration Release Notes

Bug Fixes

- Pin `sybil` to < 6.1

Sybil 6.1.0 fixes a bug which we thought it was proper behavior, so
upgrading to it would break our tests.


**Full Changelog**: https://github.com/frequenz-floss/frequenz-repo-config-python/compare/v0.9.1...v0.9.2

Frequenz Repository Configuration Release Notes

Bug Fixes

- Fix that new repositories were initialized with the previous version 0.8.0.


What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/228
* Initialize repos to version 0.9.1 by Marenz in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/231
* Clean up release notes for 0.9.1 by llucax in https://github.com/frequenz-floss/frequenz-repo-config-python/pull/232


**Full Changelog**: https://github.com/frequenz-floss/frequenz-repo-config-python/compare/v0.9.0...v0.9.1