Skip to content
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

Fix the outdated version number in the template #380

Merged
merged 2 commits into from
Mar 29, 2025
Merged

Fix the outdated version number in the template #380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4b7437
Clear release notes and migration script
llucax Mar 29, 2025
00902ab
Fix the repo-config version number that was outdated
llucax Mar 29, 2025
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
46 changes: 2 additions & 44 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,7 @@
# 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](https://frequenz-floss.github.io/frequenz-repo-config-python/v0.13/user-guide/start-a-new-project/configure-github/#rulesets).

> [!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.

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

But 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-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.
* Check the new dependabot configuration file if you customized the dependabot configuration for the `pip` ecosystem.
* 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
## Bug Fixes

### 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][ubuntu-20.04]. 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.

[ubuntu-20.04]: https://github.blog/changelog/2025-01-15-github-actions-ubuntu-20-runner-image-brownout-dates-and-other-breaking-changes/

- The Python `Protect version branches` branch protection rule now request review to Copilot by default.
- Fix the repo-config version number that was outdated.
Loading