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

Add collapsible element to updater notification to show changelog, open if there breaking changes #4051

Merged
merged 9 commits into from
Oct 15, 2024

Conversation

franknoirot
Copy link
Collaborator

@franknoirot franknoirot commented Sep 30, 2024

Closes #3984. Need to test the updater to ensure that we still get the markdown of the release notes to be able to parse them. I think I still need to add error handling if the notes are undefined.

Yeah at least in the updater test I'm not receiving any release notes to parse, so I'm getting an error. Need to test the component out with some fake notes data (oh and I can write a component test for it!), then coordinate with @pierremtb to make sure the app has the release notes markdown when returned from the auto-updater.

Copy link

qa-wolf bot commented Sep 30, 2024

QA Wolf here! As you write new code it's important that your test coverage is keeping up.
Click here to request test coverage for this PR!

Copy link

vercel bot commented Sep 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
modeling-app ✅ Ready (Inspect) Visit Preview Oct 14, 2024 4:12pm

@pierremtb
Copy link
Collaborator

@franknoirot I'm trying to push a dummy updater-test build with https://github.com/KittyCAD/modeling-app/tree/updater-test that would include the release notes so we can test this branch with that. They aren't currently being populated on release

@pierremtb
Copy link
Collaborator

pierremtb commented Oct 7, 2024

@franknoirot
Copy link
Collaborator Author

Need to fix this windows failure https://github.com/KittyCAD/modeling-app/actions/runs/11214762223/job/31170760758 before we can move on though

New attempt is at https://github.com/KittyCAD/modeling-app/actions/runs/11214995573

Great, thank you. I'll still make the component resilient to if release notes aren't present, but that will be very helpful for confirming it's appearance.

@pierremtb
Copy link
Collaborator

Made good progress, had to rework the way notes were published I had understood the docs wrong. This is what it looks like in an updater test related to #4123

Found version 0.255.255 (url: Zoo Modeling App-0.255.255-x64-mac.zip, Zoo Modeling App-0.255.255-arm64-mac.zip, Zoo Modeling App-0.255.255-x64-mac.dmg, Zoo Modeling App-0.255.255-arm64-mac.dmg)
update-available {
  version: '0.255.255',
  files: [
    {
      url: 'Zoo Modeling App-0.255.255-x64-mac.zip',
      sha512: 'VJb0qlrqNr+rVx3QLATz+B28dtHw3osQb5/+UUmQUIMuF9t0i8dTKOVL/2lyJSmLJVw2/SGDB4Ud6VlTPJ6oFw==',
      size: 141277345
    },
    {
      url: 'Zoo Modeling App-0.255.255-arm64-mac.zip',
      sha512: 'b+ugdg7A4LhYYJaFkPRxh1RvmGGMlPJJj7inkLg9PwRtCnR9ePMlktj2VRciXF1iLh59XW4bLc4dK1dFQHMULA==',
      size: 135278259
    },
    {
      url: 'Zoo Modeling App-0.255.255-x64-mac.dmg',
      sha512: 'gCUqww05yj8OYwPiTq6bo5GbkpngSbXGtenmDD7+kUm0UyVK8WD3dMAfQJtGNG5HY23aHCHe9myE2W4mbZGmiQ==',
      size: 146004232
    },
    {
      url: 'Zoo Modeling App-0.255.255-arm64-mac.dmg',
      sha512: 'ND871ayf81F1ZT+iWVLYTc2jdf/Py6KThuxX2QFWz14ebmIbJPL07lNtxQOexOFiuk0MwRhlCy1RzOSG1b9bmw==',
      size: 140021522
    }
  ],
  path: 'Zoo Modeling App-0.255.255-x64-mac.zip',
  sha512: 'VJb0qlrqNr+rVx3QLATz+B28dtHw3osQb5/+UUmQUIMuF9t0i8dTKOVL/2lyJSmLJVw2/SGDB4Ud6VlTPJ6oFw==',
  releaseNotes: 'Non-release build, commit d6488ecf784c0559bcbeaacc1fc4f22820037846\n',
  releaseDate: '2024-10-09T11:57:59.133Z'
}

@pierremtb
Copy link
Collaborator

Thanks @franknoirot for merging #3995! Just updated from main, hope I didn't mess up conflict resolution

@franknoirot
Copy link
Collaborator Author

Just finishing some component test finessing but here's what I'm thinking for the look for now

image

@franknoirot
Copy link
Collaborator Author

And if the word "breaking" appears in the release notes:

image

Comment on lines 16 to 17
CUT_RELEASE_PR: true
BUILD_RELEASE: true
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
CUT_RELEASE_PR: true
BUILD_RELEASE: true
CUT_RELEASE_PR: ${{ github.event_name == 'pull_request' && (contains(github.event.pull_request.title, 'Cut release v')) }}
BUILD_RELEASE: ${{ github.event_name == 'release' || github.event_name == 'schedule' || github.event_name == 'pull_request' && (contains(github.event.pull_request.title, 'Cut release v')) }}

Don't let me merge this without reverting this part

@franknoirot franknoirot marked this pull request as ready for review October 11, 2024 23:07
@pierremtb
Copy link
Collaborator

🔥

@pierremtb
Copy link
Collaborator

updater-test looking good here, let me remove the release builds for merge!

image

Copy link
Collaborator

@pierremtb pierremtb left a comment

Choose a reason for hiding this comment

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

LGTM!

@pierremtb pierremtb merged commit d361bda into main Oct 15, 2024
26 checks passed
@pierremtb pierremtb deleted the franknoirot/3984/show-changelog-in-update-toast branch October 15, 2024 11:30
lf94 pushed a commit that referenced this pull request Oct 16, 2024
…en if there breaking changes (#4051)

* Add collapsible element to updater toast notification showing release notes

* Temp create release artifacts to test updater

* Fix tsc error

* Fix some styling, make release notes not appear if no notes are present

* Add component tests

* Remove test release builds

---------

Co-authored-by: Pierre Jacquier <[email protected]>
@pierremtb pierremtb mentioned this pull request Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Changelog view or Breaking Change Message
2 participants