chore: Updates CHANGELOG.md with 4.0.2 data#29600
Conversation
| ## Change Log | ||
|
|
||
| ### 4.0.2 (Wed Jun 26 14:26:58 2024 -0300) | ||
|
|
There was a problem hiding this comment.
| Highlights of this patch release: | |
| - New alerts & reports can now be saved, fixing [a widely-reported bug](https://github.com/apache/superset/issues/28149) introduced in 4.0.0. | |
| - As a side effect of the fix in #29345, the y-axis ordering is now reversed on horizontal bar charts. Users who wish to retain the ordering they had in 4.0.1 can toggle the `Y-Axis Sort Ascending` box in a chart's editor view. |
There was a problem hiding this comment.
The commit title "fix(ar-modal): updateNotificationSettings not updating state" doesn't describe for most people that the alert & report modal now works again. I wanted to call that bugfix out specifically. And then note the change of behavior introduced by the other PR. These are the two things that felt to me like admins should know them, vs. other things that are more behind-the-scenes fixes.
There was a problem hiding this comment.
@sfirke I believe every fix is a highlight of a particular importance depending on if you are being affected by the fix. It's the responsibility of the PR author to write a good PR title/description, so I suggest editing the respective PRs to include more context instead of changing the template of the CHANGELOG.
There was a problem hiding this comment.
I was thinking of a mini-version of release notes, like https://github.com/apache/superset/blob/master/RELEASING/release-notes-4-0/README.md for 4.0.0. I don't mean to mess with the CHANGELOG template; is there a place such mini release notes could go?
Not to take away from the other PRs, but objectively there are many more people asking about the alert/report fix in Slack than any other PR in this release. And I don't expect anyone to click and read through every PR, which is what would be necessary to know about the side effect of the #29345 change with bars reordering. I had reported that as a bug b/c I was unaware of it being a known side effect; calling it out here might stop other people from being similarly confused.
I think it will benefit the project to call out these two, as it may reduce unnecessary GitHub issues and Slack questions. But I will admit I don't know where that should go.
There was a problem hiding this comment.
I don't expect anyone to click and read through every PR
That's what we assume people will do with our current CHANGELOG template. Our CHANGELOG is automatically generated using the PR's titles, which I think will never be sufficient to fully understand the changes. One alternative would be to change our template to actually add meaningful descriptions that wouldn't require people to go the PRs. The problem with this is the amount of work necessary to produce such CHANGELOG and the possible effort duplication with well written PRs.
Considering our current template, that assumes that people need to check the PRs, I would suggest editing the poorly described PRs.
This may be a good topic for the next Town Hall.
There was a problem hiding this comment.
Okay, sounds good. Thanks for the explanation.
SUMMARY
Updates
CHANGELOG.mdwith 4.0.2 data. It also updates the versions selector of the issue template.ADDITIONAL INFORMATION