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

Support Auto Diff of Schemas for Changelogs #1120

Open
boyney123 opened this issue Feb 5, 2025 · 0 comments
Open

Support Auto Diff of Schemas for Changelogs #1120

boyney123 opened this issue Feb 5, 2025 · 0 comments

Comments

@boyney123
Copy link
Collaborator

Use Case

When a resource (e.g event) has a version, and both the latest version and previous version have a schema.json for example, the Changelog page for that event should show a diff of the schema for the user.

We have generators that are versioning things for users, but the change log is blank. I think there could be value here, showing the diffs for folks through automation.

Proposed Solution

When we load the changlog, somehow we also check the files and compare them, in this case its the schema for the event and compare them and show that diff in the UI.

Implementation Notes

No response

Community Notes

  • Please vote by adding a 👍 reaction to the issue to help us prioritize.
  • If you are interested to work on this issue, please leave a comment.
  • If this issue is labeled needs-discussion, it means the spec has not been finalized yet. Please reach out in the EventCatalog Discord.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant