-
Notifications
You must be signed in to change notification settings - Fork 4
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
base: next
Are you sure you want to change the base?
Conversation
@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. |
b2cdf8c
to
a48b7e2
Compare
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. |
fa1a118
to
7ef3657
Compare
2a67fa8
to
bd3a9e9
Compare
bd3a9e9
to
ca28a57
Compare
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 ☂️ |
f19c159
to
c68c5d2
Compare
c68bc6f
to
2e8acbf
Compare
53b45ca
to
99eef6f
Compare
e202711
to
33afd55
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good! Added a few code comments
<TableCell className={styles.channelNameCell}> | ||
<ol className={styles.versionList}> | ||
{versions.map((version) => { | ||
const changes = changelogData?.[version.version] ?? [] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was a bit surprised to see this as an array... would it not be better to store / display just a markdown text block for each version change as GitHub releases does?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it was like that initially to keep the changes in a structured format and display them consistently, to do things like:
- we were displaying the change type in a cell in a table so this was better than doing regex parsing at last minute
- renaming the change types: "feat" to "feature" etc..
- highlighting (or ignoring) translations
- being able to show only bugs or features, or group by change type (never did that but thought it makes sense when we're showing the changes vs instlaled version for example that we'd show all features then all bugs..)
slowly though, the design evolved, and we're not doing any of these .. so I could go back to just having an array of versions, and the changes as a markdown that we display as it is
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@amcgee updated it to just show the raw markdown:
ed516a0
to
60cdfae
Compare
instead of trying to parse into a structured format
7acf314
to
cd51dcb
Compare
implements HUB-160
The PR adds the ability to view an app change log:
change_summary
, where the users can write whatever they want to describe what changed in a specific versionchange_summary
exists, it will be displayed first next to the entry (then any other changes from the changelog)It also:
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-3.webm
obsolete versions
ignore - just leaving the video if we want to refer back
https://github.com/user-attachments/assets/f4348a53-b2c4-4a73-a482-1ce688c87566
https://github.com/user-attachments/assets/307aa427-8f59-4f81-b0a0-ba0f91ac8a96