v0.10.0

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:

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

New Contributors

• @dependabot made their first contribution in #248

Full Changelog: v0.9.1...v0.10.0