Skip to content

Commit c0410d1

Browse files
authored
Clear release notes and migration script (#591)
2 parents 9536002 + fc60469 commit c0410d1

2 files changed

Lines changed: 13 additions & 1892 deletions

File tree

RELEASE_NOTES.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
## Summary
44

5-
This release focuses on finishing the automation of dependabot updates, adding more automated upgrade workflows and fixing some problems with the previous release.
5+
<!-- Here goes a general summary of what this release is about -->
66

77
## Upgrading
88

9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10+
911
### Cookiecutter template
1012

1113
All upgrading should be done via the migration script or regenerating the templates.
@@ -14,28 +16,22 @@ All upgrading should be done via the migration script or regenerating the templa
1416
curl -sSLf https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/<tag>/cookiecutter/migrate.py | python3 -I
1517
```
1618

19+
But you might still need to adapt your code:
20+
21+
<!-- Here upgrade steps for cookiecutter specifically -->
22+
1723
## New Features
1824

25+
<!-- Here goes the main new features and examples or instructions on how to use them -->
26+
1927
### Cookiecutter template
2028

21-
- The cookiecutter now asks whether a repository is private, defaults that answer from the selected license, and uses it to toggle private-repository workflow behavior, public publishing jobs, and the link to GitHub Discussions in the issue template chooser.
22-
- All dependencies have been updated in the templates.
23-
- API projects now ship a dedicated `grpc-migration.yaml` workflow that runs after Dependabot bumps `grpcio`/`grpcio-tools`/`protobuf` and rewrites the matching runtime `>=` floors in `pyproject.toml`.
24-
- API projects now have a better grpcio/protobuf updates grouping in Dependabot, which should make upgrading easier, and plays nicer with the new `grpc-migration.yaml` workflow.
25-
- API projects should now use the new API-specific *Protect version branches* ruleset variant, which includes the required `Fix gRPC/protobuf runtime floors` check without affecting non-API Python projects.
26-
- Workflows using the `gh-action-dependabot-migrate` are upgraded to the latest version, which avoids unnecessary version iterations.
27-
- Add an `isort-migration.yaml` workflow that automatically reorders imports when Dependabot upgrades `isort`.
29+
<!-- Here new features for cookiecutter specifically -->
2830

2931
## Bug Fixes
3032

33+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
34+
3135
### Cookiecutter template
3236

33-
- 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`.
34-
- Private repositories now are generated with credentials uncommented and the publishing workflows disabled.
35-
- The issue template chooser (`config.yml`) no longer includes the `contact_links` section for private repositories, since GitHub Discussions are typically disabled for them.
36-
- Normalized the GitHub Action hashes for `gh-action-setup-git` and `gh-action-setup-python-with-deps` to point to the actual commit object, which is what Dependabot expects.
37-
- API projects now configure black with `extend-exclude = '^/submodules/'` so the formatting check doesn't descend into external git submodules that don't follow our formatting rules.
38-
- API projects now configure isort with `skip_glob = ["submodules/*"]` so the import-sorting check doesn't descend into external git submodules that don't follow our rules.
39-
- `CONTRIBUTING.md`
40-
* Fixed the nox example commands in to use the correct `tests/` directory instead of the non-existent `test/` directory.
41-
* Fixed the wrong mention to PyPI publishing when releasing for private repositories.
37+
<!-- Here bug fixes for cookiecutter specifically -->

0 commit comments

Comments
 (0)