abapGit/docs/collections/_development/guide-changelog.md
sandraros fa5cf53914
Update guide-changelog.md (#5127)
The changelog is displayed only if the repository contains a class which implements `ZIF_APACK_MANIFEST`, whose constructor initializes the current version in attribute `zif_apack_manifest~descriptor-version`.
2021-11-11 17:53:21 -05:00

828 B

title order
Changelog 150

abapGit allows to show a changelog notes, based on changelog file in the repository base, and on APACK class containing the current version.

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.