mirror of
https://github.com/abapGit/abapGit.git
synced 2025-05-02 04:36:49 +08:00
f9b98190f1
* Create guide-changelog.md * Rename docs/collections/guide-changelog.md to docs/collections/_development/guide-changelog.md Co-authored-by: Lars Hvam <larshp@hotmail.com>
41 lines
701 B
Markdown
41 lines
701 B
Markdown
---
|
|
title: Changelog
|
|
order: 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
|
|
* [Semantic version](https://semver.org/)
|
|
* Separator: ------------------
|
|
* Version notes
|
|
```
|
|
2020-06-29 v1.97.0
|
|
------------------
|
|
+ Notes.....
|
|
```
|
|
|
|
Check [abapGit changelog](https://github.com/larshp/abapGit/blob/master/changelog.txt) as texample
|