From f9b98190f1cd0bd5904528c4fa5b7c2d2b9d57c9 Mon Sep 17 00:00:00 2001 From: Jaime Rodriguez Capote Date: Sun, 5 Jul 2020 18:04:19 +0200 Subject: [PATCH] Changelog documentation (#3583) * Create guide-changelog.md * Rename docs/collections/guide-changelog.md to docs/collections/_development/guide-changelog.md Co-authored-by: Lars Hvam --- .../_development/guide-changelog.md | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/collections/_development/guide-changelog.md diff --git a/docs/collections/_development/guide-changelog.md b/docs/collections/_development/guide-changelog.md new file mode 100644 index 000000000..3d82f0a84 --- /dev/null +++ b/docs/collections/_development/guide-changelog.md @@ -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