abapGit/docs/collections/_development/guide-changelog.md
Marc Bernard ce731ecd22
Docs: Formatting of changelog description (#4819)
Co-authored-by: Lars Hvam <larshp@hotmail.com>
2021-06-04 15:14:43 +02:00

758 B

title order
Changelog 150

abapGit allows to show a changelog notes, based on changelog file in the repository base

File format

A file named as pattern CHANGELOG* or changelog*

Changelog file should have a specific format:

Header with the title

abapGit changelog
=================

A legend

Legend
------
* : fixed
! : changed
+ : added
- : removed

Notes section using header format:

  • Date in format YYYY-MM-DD followed by Semantic version
  • Separator: ------------------
  • Version notes using a prefix as described in the legend
2020-06-29 v1.97.0
------------------
+ Notes.....

Check abapGit changelog as an example.