doc: added git-cliff for easy changelog generation #30
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
git-cliff uses a config.toml file present at the root directory of the project and generates a changelog as follows: ```git cliff -vv -u -o CHANGELOG.md``` Signed-off-by: jay-dee7 <jasdeepsingh.uppal@gmail.com>
jay-dee7
force-pushed
the
changelog-generation
branch
from
2d76829 to
3495e91
Compare
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.
Easy Changelog generation
We can use git-cliff but this needs to be installed on the system first. On MacOS, if you have rust toolchain installed, run the following command to install git-cliff:
cargo install git-cliffgit-cliff uses a config.toml file present at the root directory of the project and generates a changelog as follows:
git cliff -vv -u -o CHANGELOG.mdgit cliff -vv -u --prepend CHANGELOG.mdSigned-off-by: jay-dee7 jasdeepsingh.uppal@gmail.com