Skip to content

Prepare release notes for the v1.0.0-rc3 release #775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 8, 2023

Conversation

llucax
Copy link
Contributor

@llucax llucax commented Nov 8, 2023

Remove notes from the rc2 release and update release notes for the v1.0.0-rc3 release.

The release notes were not cleared after the rc2 release, so we remove
them now.

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax llucax requested a review from a team as a code owner November 8, 2023 09:41
@llucax llucax self-assigned this Nov 8, 2023
@llucax llucax added this to the v1.0.0-rc3 milestone Nov 8, 2023
@github-actions github-actions bot added the part:docs Affects the documentation label Nov 8, 2023
@llucax llucax added the type:enhancement New feature or enhancement visitble to users label Nov 8, 2023
@llucax llucax enabled auto-merge November 8, 2023 09:58
RELEASE_NOTES.md Outdated
* The `propose_*` methods send power proposals to the `PowerManagingActor`, where it can be overridden by proposals from other actors.
* They no longer have the `adjust_power` flag, because the `PowerManagingActor` will always adjust power to fit within the available bounds.
* They no longer have a `include_broken_batteries` parameter. The feature has been removed.
* `BatteryPool`: The `include_broken_batteries` argument was removed from the control methods. This option is no longer supported.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this belongs to - BatteryPool's control methods which has been removed and not to microgrid package

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean because the BateryPool object is defined in timeseries?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nevermind, I've just understood the changes done

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ouch, please don't approve if you see any issues and auto-merge is enabled 😆

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I looked at the commit and see this is not exposed via microgrid.battery_pool(), so OK, will put it outside the microgrid package.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, this was very hard to track what was really changed and which parts were affected. @frequenz-floss/python-sdk-team when writing release notes we should think more from the user's perspective at the time to upgrade to write good notes, useful notes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to hopefully really reflect the user-visible changes and in a useful way.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure what the confusion is, the flag was part of the battery pools control methods, and they've gone away: https://frequenz-floss.github.io/frequenz-sdk-python/v0.25/reference/frequenz/sdk/timeseries/battery_pool/#frequenz.sdk.timeseries.battery_pool.BatteryPool.charge

this was not about power distributing actor internals.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It affects the access via microgrid.battery_pool() (which IMHO is the main thing the user cares about) and also some other public (although probably not used by users really) interfaces.

@llucax llucax added this pull request to the merge queue Nov 8, 2023
@llucax llucax removed this pull request from the merge queue due to a manual request Nov 8, 2023
@llucax llucax added this pull request to the merge queue Nov 8, 2023
Merged via the queue into frequenz-floss:v1.x.x with commit 504b86f Nov 8, 2023
@llucax llucax deleted the release-notes-rc3 branch November 8, 2023 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:docs Affects the documentation type:enhancement New feature or enhancement visitble to users
Projects
Development

Successfully merging this pull request may close these issues.

3 participants