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.

Sign up for GitHub

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

Jump to bottom

update changelog for 0.20.0 #2984

Closed
wants to merge 1 commit into from
Closed

update changelog for 0.20.0 #2984

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Changelog

## ✨ yew **0.20.0** *(2022-11-xx)*
## ✨ yew **0.20.0** *(2022-11-25)*

#### Changelog

- #### 🚨 Breaking changes
Copy link
Member

Choose a reason for hiding this comment

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

Interesting i never knew we had a breaking changes section before.

Currently we generate the change log using our own generator.
If we add this section back, we need to add it there as well.

Copy link
Member

Choose a reason for hiding this comment

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

Though i am not sure f the implications for maintainers, would this mean another label we need to add on PR's?

Copy link
Member

Choose a reason for hiding this comment

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

There already is a label, is think it's just not being used in the changelog generator, as far as I see: breaking change

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 also think mentioning that csr is now a required Cargo feature for old code to continue working is worth mentioning somewhere in the changelog. This doesn't seem directly and explicitly mentioned as far as I can see, and certainly not prominent like in a breaking change section.

Copy link
Member

Choose a reason for hiding this comment

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

We never had a section for breaking changes, only migration guide. The breaking change label isn't used in the change log generator

I think this information can go in the migration guide (if not present already)

Copy link
Member

Choose a reason for hiding this comment

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

Yes, all the breaking changes are recorded in the migration guide.

I am in favour of having a breaking change section in the changelog.
However, if we were to accept this pull request, we also need to retrospectively pick all breaking changes from the changelog for v0.20.

Maybe it would be better to start tracking breaking changes from the next release?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Given this, I would suggest to link the migration guide from the top of the changelog.

I did not know such existed, which was why I was looking at the changelog after my code broke upon updating. I just tried to find the migration guide and had some difficulty with this step. I'm still not sure I was looking at the correct document, but the document I found seemed perhaps a bit incomplete.

- Remove `yew::start_app::<App>()`. (Use
`yew::Renderer::<App>::new().render()` instead).

- #### 🛠 Fixes

- Fix onsubmit event type in docs. [[@Allan](https://github.com/Allan), [#2926](https://github.com/yewstack/yew/pull/2926)]
Expand Down