Repository navigation
chore: add changelog generation workflow and initial changelog files - #8
Merged
Merged
Conversation
Awesome-Ace22
added
documentation
Awesome-Ace22
changed the title
This file contains hidden or 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
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.
This pull request introduces automated changelog generation and updates project documentation to clarify setup, structure, and release tracking. The main changes are the addition of a GitHub Actions workflow to generate and PR a
CHANGELOG.mdafter each release, a configuration file for changelog formatting, the initial generated changelog, and a significantly improvedREADME.mdwith clearer instructions and structure.Changelog automation:
.github/workflows/changelog.ymlto automatically generateCHANGELOG.mdusing git-cliff and open/update a PR intodevafter each release or on demand. This ensures changelogs are always up to date and consistent.cliff.tomlconfiguration file to define how git-cliff formats and groups changelog entries, following Conventional Commits and Nova release tags.Documentation updates:
CHANGELOG.md, generated by git-cliff, to provide a clear, automated record of changes per Nova release.README.mdto clarify the project’s purpose, structure, setup, troubleshooting, and links to further documentation. This makes onboarding and contribution easier for new developers and operators.