Skip to content

Commit a571f67

Browse files
committed
chore(release): Update RELEASE_NOTES.md to reflect dependency update for frequenz-api-assets
Signed-off-by: eduardiazf <[email protected]>
1 parent 29010a7 commit a571f67

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

RELEASE_NOTES.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,31 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
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.
66

7-
## Upgrading
7+
## Changes
88

9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
9+
### Dependency Updates
1010

11-
## New Features
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
1215

13-
<!-- Here goes the main new features and examples or instructions on how to use them -->
16+
## Benefits
1417

15-
## Bug Fixes
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
1621

17-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
22+
## Migration Notes
23+
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

0 commit comments

Comments
 (0)