Skip to content

Prepare for v0.17.0 release #557

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 4 commits into from
Mar 30, 2026
Merged

Prepare for v0.17.0 release #557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f125700
Normalize tag comment
llucax Mar 18, 2026
9bc1d61
Fix wrong trailing quote in migration script
llucax Mar 30, 2026
b8165c5
Prepare release notes for the v0.17.0 release
llucax Mar 26, 2026
3d3a0de
template: Bump version to the upcoming v0.17.0
llucax Mar 26, 2026
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
2 changes: 1 addition & 1 deletion .github/workflows/labeler.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
# only use hashes to pick the action to execute (instead of tags or branches).
# For more details read:
# https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
uses: actions/labeler@634933edcd8ababfe52f92936142cc22ac488b1b # 6.0.1
uses: actions/labeler@634933edcd8ababfe52f92936142cc22ac488b1b # v6.0.1
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
dot: true
12 changes: 3 additions & 9 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 improves workflows security, adds a black migration workflow, and fixes failed migrations from version v0.16.0.

## 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 @@ -18,20 +16,16 @@ curl -sSLf https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config

But you might still need to adapt your code:

<!-- Here upgrade steps for cookiecutter specifically -->

## New Features

<!-- Here goes the main new features and examples or instructions on how to use them -->

### Cookiecutter template

- Add a `black-migration.yaml` workflow that automatically reformats code when Dependabot upgrades `black`.

## Bug Fixes

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

### Cookiecutter template

- Fix migration of CI workflow matrices that used `arch`/`os` dimensions with values different from the default template. The v0.16.0 migration relied on exact string matching, so projects with customized matrix items (for example `arch: [amd64]`, `os: [ubuntu-24.04]`) could be left only partially migrated. The new migration step rebuilds the `platform` entries from the existing `arch`/`os` values and only rewrites `runs-on` when it still points to the old matrix keys.
- Improve workflows security: tighten permissions, avoid potential shell injection, run Python in isolated mode, pin all dependencies using the SHA hash.
- The unused cross-arch QEMU-based testing infrastructure has been removed. The `.github/containers/nox-cross-arch/` and `.github/containers/test-installation/` directories, as well as the "Cross-Arch Testing" section in `CONTRIBUTING.md`.
2 changes: 1 addition & 1 deletion cookiecutter/migrate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
- name: Migrate
uses: frequenz-floss/gh-action-dependabot-migrate@"""
# Broken just to avoid flake8 maximum line length check
"""b389f72f9282346920150a67495efbae450ac07b # v1.1.0"
"""b389f72f9282346920150a67495efbae450ac07b # v1.1.0
with:
migration-script: |
import os
Expand Down
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 == 80.9.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.16.0",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.17.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 @@ -104,7 +104,7 @@ dev-mkdocs = [
"mkdocs-material == 9.6.18",
"mkdocstrings[python] == 1.0.0",
"mkdocstrings-python == 2.0.1",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.16.0",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.17.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -117,7 +117,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2025.5.1",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.16.0",
"frequenz-repo-config[{{cookiecutter.type}}] == 0.17.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -127,7 +127,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.16.0",
"frequenz-repo-config[extra-lint-examples] == 0.17.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 == 80.9.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[actor] == 0.16.0",
"frequenz-repo-config[actor] == 0.17.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -61,7 +61,7 @@ dev-mkdocs = [
"mkdocs-material == 9.6.18",
"mkdocstrings[python] == 1.0.0",
"mkdocstrings-python == 2.0.1",
"frequenz-repo-config[actor] == 0.16.0",
"frequenz-repo-config[actor] == 0.17.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -71,7 +71,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2025.5.1",
"frequenz-repo-config[actor] == 0.16.0",
"frequenz-repo-config[actor] == 0.17.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -81,7 +81,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.16.0",
"frequenz-repo-config[extra-lint-examples] == 0.17.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 == 80.9.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[api] == 0.16.0",
"frequenz-repo-config[api] == 0.17.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 @@ -72,7 +72,7 @@ dev-mkdocs = [
"mkdocs-material == 9.6.18",
"mkdocstrings[python] == 1.0.0",
"mkdocstrings-python == 2.0.1",
"frequenz-repo-config[api] == 0.16.0",
"frequenz-repo-config[api] == 0.17.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -83,7 +83,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2025.5.1",
"frequenz-repo-config[api] == 0.16.0",
"frequenz-repo-config[api] == 0.17.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -93,7 +93,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.16.0",
"frequenz-repo-config[extra-lint-examples] == 0.17.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 == 80.9.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[app] == 0.16.0",
"frequenz-repo-config[app] == 0.17.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[app] == 0.16.0",
"frequenz-repo-config[app] == 0.17.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -70,7 +70,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2025.5.1",
"frequenz-repo-config[app] == 0.16.0",
"frequenz-repo-config[app] == 0.17.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.16.0",
"frequenz-repo-config[extra-lint-examples] == 0.17.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 == 80.9.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[lib] == 0.16.0",
"frequenz-repo-config[lib] == 0.17.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -57,7 +57,7 @@ dev-mkdocs = [
"mkdocs-material == 9.6.18",
"mkdocstrings[python] == 1.0.0",
"mkdocstrings-python == 2.0.1",
"frequenz-repo-config[lib] == 0.16.0",
"frequenz-repo-config[lib] == 0.17.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -67,7 +67,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2025.5.1",
"frequenz-repo-config[lib] == 0.16.0",
"frequenz-repo-config[lib] == 0.17.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -77,7 +77,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.16.0",
"frequenz-repo-config[extra-lint-examples] == 0.17.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 == 80.9.0",
"setuptools_scm[toml] == 8.1.0",
"frequenz-repo-config[model] == 0.16.0",
"frequenz-repo-config[model] == 0.17.0",
]
build-backend = "setuptools.build_meta"

Expand Down Expand Up @@ -61,7 +61,7 @@ dev-mkdocs = [
"mkdocs-material == 9.6.18",
"mkdocstrings[python] == 1.0.0",
"mkdocstrings-python == 2.0.1",
"frequenz-repo-config[model] == 0.16.0",
"frequenz-repo-config[model] == 0.17.0",
]
dev-mypy = [
"mypy == 1.9.0",
Expand All @@ -71,7 +71,7 @@ dev-mypy = [
]
dev-noxfile = [
"nox == 2025.5.1",
"frequenz-repo-config[model] == 0.16.0",
"frequenz-repo-config[model] == 0.17.0",
]
dev-pylint = [
# dev-pytest already defines a dependency to pylint because of the examples
Expand All @@ -81,7 +81,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.16.0",
"frequenz-repo-config[extra-lint-examples] == 0.17.0",
"pytest-mock == 3.14.0",
"pytest-asyncio == 1.1.0",
"async-solipsism == 0.8",
Expand Down
Loading