mirror of
https://github.com/abapGit/abapGit.git
synced 2025-05-02 04:36:49 +08:00
fa5cf53914
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`.
43 lines
828 B
Markdown
43 lines
828 B
Markdown
---
|
|
title: Changelog
|
|
order: 150
|
|
---
|
|
|
|
abapGit allows to show a changelog notes, based on changelog file in the repository base, and on [APACK](ref-apack.html) 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](https://semver.org/)
|
|
* Separator: ------------------
|
|
* Version notes using a prefix as described in the legend
|
|
|
|
```
|
|
2020-06-29 v1.97.0
|
|
------------------
|
|
+ Notes.....
|
|
```
|
|
|
|
Check [abapGit changelog](https://github.com/abapGit/abapGit/blob/main/changelog.txt) as an example.
|