Reset release notes #1225
Merged
Reset release notes #1225
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Elzbieta Kotulska <[email protected]>
ela-kotulska-frequenz
requested review from
daniel-zullo-frequenz
and removed request for
a team
There was a problem hiding this comment.
Pull Request Overview
This PR resets the release notes structure by adding placeholder sections for a summary, upgrading instructions, and detailed notes under new features and bug fixes.
- Introduces a “Summary” section placeholder
- Adds an “Upgrading” section placeholder
- Inserts comments indicating where New Features and Bug Fixes details should go
|
|
||
| ## Summary | ||
|
|
||
| <!-- Here goes a general summary of what this release is about --> |
There was a problem hiding this comment.
Replace this placeholder with a concise summary of the key improvements and focus areas in this release.
Suggested change
| <!-- Here goes a general summary of what this release is about --> | |
| This release introduces several key improvements, including enhanced performance for data processing, new APIs for energy monitoring, and critical bug fixes to improve stability and reliability. |
Comment on lines
+9
to
+10
| <!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with --> | ||
|
|
There was a problem hiding this comment.
Populate this section with step-by-step upgrade instructions, highlighting any breaking changes or removed features.
Suggested change
| <!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with --> | |
| This release introduces the following changes that may require action when upgrading: | |
| 1. **Breaking Change:** The `old_function` has been removed. Replace it with `new_function` as follows: | |
| ```python | |
| # Before | |
| result = old_function(arg1, arg2) | |
| # After | |
| result = new_function(arg1, arg2) |
-
Deprecated Feature: The
deprecated_featureis now deprecated and will be removed in a future release. Usereplacement_featureinstead:# Before deprecated_feature.do_something() # After replacement_feature.do_something()
-
Configuration Update: Update your configuration file to include the new
config_option:# Add this to your configuration config_option: true
Please review the documentation for more details on these changes.
Comment on lines
+13
to
14
| <!-- Here goes the main new features and examples or instructions on how to use them --> | ||
|
|
There was a problem hiding this comment.
List each new feature with a brief description and example usage to help users adopt them quickly.
Suggested change
| <!-- Here goes the main new features and examples or instructions on how to use them --> | |
| - **Feature 1: Enhanced Logging System** | |
| - Description: The logging system now supports structured logging with JSON format. | |
| - Example: | |
| ```python | |
| import logging | |
| from frequenz.sdk import setup_logging | |
| setup_logging(format="json") | |
| logger = logging.getLogger("example") | |
| logger.info("This is a structured log message", extra={"key": "value"}) | |
| ``` | |
| - **Feature 2: Improved Data Processing Pipeline** | |
| - Description: The data processing pipeline now includes a new filtering mechanism for outlier detection. | |
| - Example: | |
| ```python | |
| from frequenz.sdk import DataPipeline | |
| pipeline = DataPipeline() | |
| pipeline.add_outlier_filter(threshold=3.0) | |
| processed_data = pipeline.process(raw_data) | |
| ``` |
| ## Bug Fixes | ||
|
|
||
| - Fixed issue where actors would restart instead of stopping when exceptions occurred during cancellation. Actors now properly stop and surface the unhandled exception. | ||
| <!-- Here goes notable bug fixes that are worth a special mention or explanation --> |
There was a problem hiding this comment.
Detail the most impactful bug fixes, including context on the issue and how it was resolved.
Suggested change
| <!-- Here goes notable bug fixes that are worth a special mention or explanation --> | |
| - **Fixed memory leak in data processing module**: Resolved an issue where the data processing module failed to release memory after completing tasks, leading to increased memory usage over time. The issue was caused by unclosed file handles, which have now been properly managed to ensure memory is released as expected. |
shsms
approved these changes
May 26, 2025
github-project-automation
bot
moved this from To do
to Review approved
in Python SDK Roadmap
github-project-automation
bot
moved this from Review approved
to Done
in Python SDK Roadmap
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.