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 view or Breaking Change Message #3984

Closed
jgomez720 opened this issue Sep 25, 2024 · 1 comment · Fixed by #4051
Closed

Changelog view or Breaking Change Message #3984

jgomez720 opened this issue Sep 25, 2024 · 1 comment · Fixed by #4051
Assignees
Labels
bug Something isn't working high-priority

Comments

@jgomez720
Copy link
Collaborator

jgomez720 commented Sep 25, 2024

As we discussed in the post mortem, users had no visibility of the circle breaking change. This could be through

  • alert
  • error message on the code that broke. (error message on circle that has an is-was once the user hovers over it)

@jgomez720 to create an email template for these breaking changes in the future in hubspot (very needed after 1.0)
https://github.com/KittyCAD/pet-store/issues/187

@jessfraz reassign to those you need

@franknoirot
Copy link
Collaborator

Here is the description I put in #3996 before I realized it was duplicate:

We recently shipped a purposeful breaking change in KCL with #3860. However, because we didn't even have a updater toast at the time (we do now with #3902), users never got a chance to see the changelog let alone get a sense of it being serious. They just saw their existing code with circle in it all break.

Now that we have an updater toast, we want to start making it possible to tune the loudness of the messaging in that notification so that users see breaking changes coming.

My initial simple proposal is that we add the full changelog back into this toast within a collapsible disclosure. If the changelog's contents have the term "breaking" in them, we set this disclosure to open by default, but otherwise we default it to closed.

pierremtb added a commit that referenced this issue Oct 9, 2024
pierremtb added a commit that referenced this issue Oct 11, 2024
* Upload release-notes.md on release
Contributes to #3984

* Test release builds with updater-test-release-notes

* Change to releaseNotesFile conf, tested locally

* Clean up for merge
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment