Skip to content

Update release notes #159

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

Conversation

ela-kotulska-frequenz
Copy link
Contributor

No description provided.

Signed-off-by: Elzbieta Kotulska <[email protected]>
@ela-kotulska-frequenz ela-kotulska-frequenz self-assigned this Jun 2, 2025
@Copilot Copilot AI review requested due to automatic review settings June 2, 2025 09:04
@ela-kotulska-frequenz ela-kotulska-frequenz requested a review from a team as a code owner June 2, 2025 09:04
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the release notes by streamlining the document to focus on new features.

  • Removed the Summary, Upgrading, and Bug Fixes sections.
  • Retained and updated the New Features section with details about SDK support, logging level adjustments, and type changes in DispatchInfo.components.
Comments suppressed due to low confidence (1)

RELEASE_NOTES.md:2

  • Consider including a brief summary and upgrade instructions or providing a link to detailed guidance, as this context may help users understand necessary actions during the release upgrade process.
-## Summary

Signed-off-by: Elzbieta Kotulska <[email protected]>
@github-actions github-actions bot added part:docs Affects the documentation part:dispatcher Affects the high-level dispatcher interface labels Jun 2, 2025
Copy link
Contributor

@llucax llucax left a comment

Choose a reason for hiding this comment

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

Is this updating the release notes (as cleaning them up BEFORE release) or resetting them (as cleaning them up AFTER the release), because there are 2 commits doing both 🤔

@ela-kotulska-frequenz
Copy link
Contributor Author

ela-kotulska-frequenz commented Jun 2, 2025

Is this updating the release notes (as cleaning them up BEFORE release) or resetting them (as cleaning them up AFTER the release), because there are 2 commits doing both 🤔

It is intentional.
I plan to checkout to theupdate release notes commit and tag it. That way I won't forget to reset notes at the end. And it is less work.

@ela-kotulska-frequenz ela-kotulska-frequenz merged commit b6e9489 into frequenz-floss:v0.x.x Jun 2, 2025
5 checks passed
@ela-kotulska-frequenz ela-kotulska-frequenz deleted the release_notes branch June 2, 2025 09:26
@llucax
Copy link
Contributor

llucax commented Jun 2, 2025

But it is more error prone. In any case, the solution here is to automate the cleanup of the release notes (both before and after the release). Some day... some day... :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:dispatcher Affects the high-level dispatcher interface part:docs Affects the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants