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

feat: view changes between app versions based on the Changelog #747

Draft
wants to merge 4 commits into
base: next
Choose a base branch
from

Conversation

kabaros
Copy link
Contributor

@kabaros kabaros commented Dec 19, 2024

implements HUB-160

The PR adds the ability to view an app change log:

  • This is based on the CHANGELOG.md that is automatically generated for apps that use semantic-release (all of our apps)
  • We will also be exposing a manual entry for each version change_summary, where the users can write whatever they want to describe what changed in a specific version
    • When that change_summary exists, it will be displayed first next to the entry (then any other changes from the changelog)

To test this: Upload a new version of one of our apps (since these have a changelog generated) - this will update the app entry with the changelog which is then parsed and used by the UI.

UI

This is based on the design here: https://docs.google.com/document/d/1hHgEgx1XI9mjha4SArmjtEGwJzQ_XihUPhfhs8mlFhw/edit?tab=t.0#heading=h.pvxbt0ldmbhq

This is the first version of the tabbed App View page - there will be further work to merge the changelog and releases history, based on the users' feedback so far.

changelog-v2.webm

obsolete versions

ignore - just leaving the video if we want to refer back
apphub-changelog-prototype.webm

@kabaros kabaros requested review from amcgee and cooper-joe December 19, 2024 12:32
@kabaros kabaros requested review from a team and Birkbjo December 19, 2024 12:32
@kabaros
Copy link
Contributor Author

kabaros commented Dec 19, 2024

@cooper-joe @amcgee I marked this PR as draft, even though this implementation is ready - I tried to find a decent way to expose the changelog now that we have it, but I am not entirely convinced this is the right direction. I am happy to explore a completely different UX / concept (or few concepts) now that we have the changelog data ready.

@kabaros kabaros force-pushed the feat/changelog-improvement branch from b2cdf8c to a48b7e2 Compare December 19, 2024 12:39
@cooper-joe
Copy link
Member

Thanks for the explanation @kabaros, helpful to get the context. I'm taking a look at this now, exploring some design ideas for viewing and comparing changes.

@kabaros kabaros force-pushed the feat/changelog-improvement branch from fa1a118 to 7ef3657 Compare January 15, 2025 09:07
@kabaros kabaros force-pushed the feat/changelog-improvement branch 2 times, most recently from 2a67fa8 to bd3a9e9 Compare January 16, 2025 15:06
@kabaros kabaros force-pushed the feat/changelog-improvement branch from bd3a9e9 to ca28a57 Compare January 16, 2025 15:18
@codecov-commenter
Copy link

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants