Skip to content

Commit cd93587

Browse files
authored
Clear release notes (#1100)
2 parents 5b54cf4 + 0431ae4 commit cd93587

File tree

1 file changed

+4
-20
lines changed

1 file changed

+4
-20
lines changed

RELEASE_NOTES.md

+4-20
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,16 @@
22

33
## Summary
44

5-
This release focus on improving the config management, but also introduces other minor improvements and fixes an important bug.
5+
<!-- Here goes a general summary of what this release is about -->
66

77
## Upgrading
88

9-
- The `ConfigManagingActor` now takes multiple configuration files as input, and the argument was renamed from `config_file` to `config_files`. If you are using this actor, please update your code. For example:
10-
11-
```python
12-
# Old
13-
actor = ConfigManagingActor(config_file="config.toml")
14-
# New
15-
actor = ConfigManagingActor(config_files=["config.toml"])
16-
```
17-
18-
- The `MovingWindow` now take all arguments as keyword-only to avoid mistakes.
19-
- The `frequenz-quantities` dependency was bumped to `1.0.0rc3`.
20-
- The `ComponentMetricsRequest` now produces a channel name without the `start_date` if the `start_date` is `None`. If you are somehow relying on the old behavior, please update your code.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
2110

2211
## New Features
2312

24-
- The `ConfigManagingActor` can now take multiple configuration files as input, allowing to override default configurations with custom configurations.
25-
- A new `frequenz.sdk.config.load_config()` function is available to load configurations using `marshmallow_dataclass`es with correct type hints.
26-
- Implement and standardize logging configuration with the following changes:
27-
* Add `LoggerConfig` and `LoggingConfig` to standardize logging configuration.
28-
* Create `LoggingConfigUpdater` to handle runtime config updates.
29-
* Support individual log level settings for each module.
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
3014

3115
## Bug Fixes
3216

33-
- Fixes an issue where PV and EV system bounds were not available to the Power Manager sometimes when requested after startup.
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)