Skip to content
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

Clean up release notes for 0.9.1 #232

Merged
merged 1 commit into from
Feb 26, 2024

Conversation

llucax
Copy link
Contributor

@llucax llucax commented Feb 26, 2024

No description provided.

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax llucax requested a review from a team as a code owner February 26, 2024 14:27
@llucax llucax requested a review from shsms February 26, 2024 14:27
@llucax llucax self-assigned this Feb 26, 2024
@llucax llucax enabled auto-merge February 26, 2024 14:27
@llucax llucax requested a review from Marenz February 26, 2024 14:27
@llucax llucax added this to the v0.9.1 milestone Feb 26, 2024
Comment on lines -3 to -7
## Summary

<!-- Here goes a general summary of what this release is about -->

## Upgrading
Copy link
Contributor

Choose a reason for hiding this comment

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

you want to remove the headings?

Copy link
Contributor Author

@llucax llucax Feb 26, 2024

Choose a reason for hiding this comment

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

Yes (empty headings in the release notes are just noise and confusing IMHO)

Copy link
Contributor

Choose a reason for hiding this comment

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

but you're keeping the "Bug fixes" heading. And in the SDK you're keeping all the headings. Maybe nice to follow a more predictable pattern.

Copy link
Contributor

Choose a reason for hiding this comment

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

and bug fixes has an entry under it that wasn't cleaned up. is that supposed to be there?

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 always try to remove all empty headings, if that's not the case, it's a bug. I'm keeping the bug fixes header because it is not empty. I'm starting to think you believe this is a release notes cleaning after a release, but this one is cleaning the notes to make a release after it is merged.

Copy link
Contributor

Choose a reason for hiding this comment

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

oh I see, I thought it was after. Then it makes sense.

@llucax llucax added this pull request to the merge queue Feb 26, 2024
Merged via the queue into frequenz-floss:v0.x.x with commit b3925ca Feb 26, 2024
14 checks passed
@llucax llucax deleted the relnotes-0.9.1 branch February 26, 2024 15:09
@llucax llucax added the part:docs Affects the documentation label May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:docs Affects the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants