Skip to content

Commit 73e90e2

Browse files
committed
chore(release): Update RELEASE_NOTES.md to include new structure and sections
This commit restructures the RELEASE_NOTES.md file to provide clearer sections for upgrading, new features, and bug fixes. It removes specific details about the `frequenz-api-assets` dependency update, replacing them with placeholders for future content. This change aims to enhance readability and organization of release notes. Signed-off-by: eduardiazf <[email protected]>
1 parent fc92875 commit 73e90e2

File tree

1 file changed

+7
-22
lines changed

1 file changed

+7
-22
lines changed

RELEASE_NOTES.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,16 @@
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+
<!-- Here goes a general summary of what this release is about -->
66

7-
## Changes
7+
## Upgrading
88

9-
### Dependency Updates
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
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+
<!-- Here goes the main new features and examples or instructions on how to use them -->
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+
## Bug Fixes
2116

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

0 commit comments

Comments
 (0)