Skip to content

Commit 44e7006

Browse files
committed
docs: updated release notes
Signed-off-by: eduardiazf <[email protected]>
1 parent ae5da0f commit 44e7006

File tree

1 file changed

+10
-21
lines changed

1 file changed

+10
-21
lines changed

RELEASE_NOTES.md

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,20 @@
22

33
## Summary
44

5-
This release updates the `frequenz-api-assets` dependency to use a version range instead of a specific Git reference, providing more flexibility for dependency updates while maintaining compatibility.
5+
This release adds support for retrieving microgrid electrical component connections through a new client method and CLI command.
66

7-
## Changes
7+
## Upgrading
88

9-
### Dependency Updates
9+
No migration required. This is a backward-compatible feature addition.
1010

11-
* **Updated `frequenz-api-assets` dependency**:
12-
* Changed from Git reference (`@ git+https://github.com/frequenz-floss/[email protected]`) to version range (`>= 0.1.0, < 0.2.0`)
13-
* Enables automatic updates within the specified version range
14-
* Maintains backward compatibility while reducing maintenance overhead
11+
## New Features
1512

16-
## Benefits
13+
### Component Connections API
1714

18-
* **Improved dependency management**: Version ranges allow for automatic updates within the specified range
19-
* **Better compatibility**: Ensures compatibility with the project while allowing for patch and minor version updates
20-
* **Reduced maintenance overhead**: Eliminates the need to manually update Git references for compatible versions
15+
* **New `ComponentConnection` class**: Introduced to represent connections between electrical components in a microgrid
16+
* **New client method**: Added method to retrieve microgrid electrical component connections
17+
* **CLI command extension**: Added `component-connections` command to list component connections
2118

22-
## Migration Notes
19+
## Bug Fixes
2320

24-
No migration required. This is a transparent dependency update that maintains full backward compatibility.
25-
26-
## Files Changed
27-
28-
* `pyproject.toml`: Updated the `frequenz-api-assets` dependency specification
29-
30-
## Type of Change
31-
32-
* [x] Dependency update
21+
<!-- No bug fixes in this release -->

0 commit comments

Comments
 (0)