[WIP] Automated Changelog with git-cliff #131
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@kasumi-1
i added a wip feature for automating changelogs as per #37. It probably will be useful when we get out of staging.
the cliff toml includes a header (the image of the current changelog + headline) and a footer (the content of the current changelog) aswell as the parser rules (indicating where which commits should be grouped to)
this is still a wip as we would probably need to define more parser rules / regexes as well as adding info about how to ideally name commit msgs in the readme. furthermore the current changelog will be generated under /website/src/app/dashboard/changelog/changelog.mdx instead of /website/src/app/dashboard/changelog/page.mdx as to not break the currently linked changelog
WDYT is this approach suitable or did you think about something completely different in #37?