vm-build-kit/GENERATE-CHANGELOG.md

Overview

Each bullet point, or entry, in CHANGELOG.md file is generated from the subject line of a Git commit. Commits are included when they contain Changelog Git trailer. When generating the changelog, author and merge request details are added automatically.

Currently we don't use Changelog git trailer but recommend following values to apply git trailer with automated changelog generation in future release.

Suggested Changelog trailer values:

• added: New Feature
• fixed: Bug fix
• changed: Feature change
• deprecated: New deprecation
• removed: Feature removal
• security: Security fix
• performance: Performance improvement
• other: Other
• e.g 1) Git commit message to include in the changelog entries:

Update something

Now some features improved to avoid critical errors

Changelog: changed

Generate CHANGELOG.md entries from git command:

• Under Unix/Linux:

$> git log --pretty=format:'- [%s](%H) by @%cn (%cs)' | grep -v "Merge"

• Under Windows:

CommandPrompt> git log --pretty=format:'- [%s](%H) by @%cn (%cs)' | findstr /v "Merge"

Generate entries between specific vertion/tags

$> git log v0.0.1...v0.0.2 --pretty=format:'- [%s](%H) by @%cn (%cs)' | grep -v "Merge"

Generate entries from last N commits

$> git log -10 --pretty=format:'- [%s](%H) by @%cn (%cs)' | grep -v "Merge"