SAP/abapGit
1
0
Fork 0
mirror of https://github.com/abapGit/abapGit.git synced 2025-05-01 12:20:51 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Changelog documentation (#3583)

Browse Source 
* 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>
This commit is contained in:
Jaime Rodriguez Capote 2020-07-05 18:04:19 +02:00 committed by GitHub
parent 6fe168640c
commit f9b98190f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/collections/_development/guide-changelog.md Normal file
View File

@ -0,0 +1,40 @@
---
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