v0.5.2
Frequenz Repository Configuration Release Notes
Summary
This version focus on some bug fixes and final polishing of v0.5.x.
Upgrading
Cookiecutter template
-
If your replay file contains a
_extensionskey, you should remove it, as you most likely want to use the extensions declared by the repo-config cookiecutter template you are upgrading to, otherwise you could get errors about missing extensions. -
If your replay file contains a long
Introductionkey, you can replace it with an empty string (""), it doesn't need to have any particular content and it increases the size and noise in the replay file.
New Features
Cookiecutter template
-
Generated project's dependencies were bumped.
-
Move
TODOs so they are in their own line.This makes it easier to upgrade projects to new templates, as removing whole lines is easier than having to edit them.
-
Clean up
_extensionsfrom the generated replay file.It is not needed in the generated project, we always want to use the ones from the repo-config template.
This should ease upgrading projects, making it less likely to have errors about missing extensions.
-
Clean up the
Introductionvariable from the generated replay file.This is just a hack to be able to show a help about the template variables, keeping that text only increases the size and noise in the replay file.
-
Add a
\nto the end of the replay file.This is just to be nice to most editors and text files conventions, that likes it more if there is a
\nat the end of the file. -
API: The common-api documentation now is cross-linked.
Bug Fixes
Cookiecutter template
- Properly label
conftest.pyfiles.
What's Changed
- Clear release notes by @llucax in #117
- Bump repo-config and template dependencies by @llucax in #119
- Move
TODOs so they are easier to remove by @llucax in #120 - Properly label
conftest.pyfiles by @llucax in #121 - Remove obsolete extension and clean up replay file extensions by @llucax in #118
- API: Add cross-linking to common-api and prepare for the release by @llucax in #122
Full Changelog: v0.5.1...v0.5.2