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

Changelog for 0.5.0 not mentioning BREAKING #196

Closed
karfau opened this issue Mar 9, 2021 · 4 comments · Fixed by #197
Closed

Changelog for 0.5.0 not mentioning BREAKING #196

karfau opened this issue Mar 9, 2021 · 4 comments · Fixed by #197
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@karfau
Copy link
Member

karfau commented Mar 9, 2021

Some of the changes in 0.5.0 are breaking changes, so we should mention that.

@karfau karfau added the documentation Improvements or additions to documentation label Mar 9, 2021
@brodybits brodybits added the bug Something isn't working label Mar 9, 2021
@brodybits
Copy link
Member

Good catch. Do you want to propose the change?

And I think we should make the 0.5.0 release on GitHub.

I am getting ready to take my rest soon. @karfau please feel free to take care of these things, I think there is no need for me to review. Otherwise I can do this later today.

@karfau
Copy link
Member Author

karfau commented Mar 9, 2021

Yes, I plan to add a PR for it. Just wanted to make you aware before we publish it.

@brodybits
Copy link
Member

I took the liberty to publish 0.5.0 release on GitHub, with BREAKING CHANGE note added. My understanding is that it should be no problem for us to edit it if needed.

@karfau karfau added this to the 0.6.0 milestone Mar 10, 2021
@karfau
Copy link
Member Author

karfau commented Mar 10, 2021

I'll check which one will be used by Dependabot/Renovate. Not so sure if we should actually maintain it in two places.

I updated the release description and filed #197 .
Of course we also need to add the information about #168 to the changelog, but I was not sure we want to do both changes in one PR. Feel free to add those lines to the PR if you think it's helpful.

@karfau karfau linked a pull request Mar 10, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants