Skip to content

Commit 23a0584

Browse files
committed
Update release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 046971f commit 23a0584

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

RELEASE_NOTES.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,20 @@
1010

1111
### Cookiecutter template
1212

13-
All upgrading should be done via the migration script or regenerating the templates.
13+
* Branch protection rule **Protect version branches** was updated, please re-import it following the [instructions](https://frequenz-floss.github.io/frequenz-repo-config-python/v0.13/user-guide/start-a-new-project/configure-github/#rulesets).
14+
15+
> [!IMPORTANT]
16+
> 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.
17+
18+
All other upgrading should be done via the migration script or regenerating the templates.
1419

1520
```bash
1621
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.12/cookiecutter/migrate.py | python3
1722
```
1823

1924
But you might still need to adapt your code:
2025

21-
<!-- Here upgrade steps for cookiecutter specifically -->
26+
* 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-extension` library is compatible with Python 3.12 from version 4.6.0, so you might need to upgrade it if you are using it.
2227

2328
## New Features
2429

@@ -33,6 +38,18 @@ But you might still need to adapt your code:
3338
* 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.
3439
* Finally, we group some dependencies that are related to each other, and usually needs to be updated together.
3540

41+
- The GitHub workflows is now split into PRs and CI workflows.
42+
43+
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][ubuntu-20.04]. Python 3.12 is also added to the test matrix.
44+
45+
The PR action is more lightweight, and only tests with one matrix (the most widely used), so PRs can be tested more quickly.
46+
47+
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.
48+
49+
[ubuntu-20.04]: https://github.blog/changelog/2025-01-15-github-actions-ubuntu-20-runner-image-brownout-dates-and-other-breaking-changes/
50+
51+
- The Python `Protect version branches` branch protection rule now request review to Copilot by default.
52+
3653
## Bug Fixes
3754

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

0 commit comments

Comments
 (0)