You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: RELEASE_NOTES.md
+7-22Lines changed: 7 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,31 +2,16 @@
2
2
3
3
## Summary
4
4
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 -->
6
6
7
-
## Changes
7
+
## Upgrading
8
8
9
-
### Dependency Updates
9
+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10
10
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
15
12
16
-
## Benefits
13
+
<!-- Here goes the main new features and examples or instructions on how to use them -->
17
14
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
21
16
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