diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index d9f1944f..b99e3a30 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,11 +1,37 @@ # Frequenz Repository Configuration Release Notes +## Summary + + + +## Upgrading + + + +### Cookiecutter template + +All 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: + + + +## New Features + + + +### Cookiecutter template + + + ## Bug Fixes -- Fixed some typos in the docs. -- Fixed wrong comparison for `mike` versions when versions were equal. -- Fixed version regex escaping of `.`. This means that a version like v0x1e1 were accepted as valid semver versions. Now this version is not considered a semver version anymore. -- `setuptools.grpc_tools`: Fix wrong passing of include paths when passed via: + + +### Cookiecutter template - * Command-line: Now extra white-spaces and empty strings are removed, before they were passed to `protoc -I`. - * `pyproject.toml`: Now an empty array/list can be passed to override the default paths, before this resulted in an empty string being passed to `protoc -I`. +