git changelog Download - git changelog Quellcode Download

git changelog

Andere Kategorien

1.0.0

Herunterladen

Git Change Log

Eine einfache PHP -Bibliothek zum Generieren von Changelog -Datei durch Parsen Git -Protokoll -Verlauf.

Git-Changelog analysiert den Git-History, das in der Dauer start date working directory end date vorgesehen ist, und generiert Änderungsprotokolle.

ChangeLogs können in den folgenden Ausgabedformaten generiert werden, indem die Eigenschaft output format beim Generieren von Protokollen festgelegt wird.

Markdown (Standard -MD -Format)
Bemerkung (siehe Phabricator Bemerkungshandbuch)
Html
JSON

Format begehen

Git-Changelog erwartet, dass sich Commits im folgenden Format befinden.

type : commit-message

Typ kann einer der folgenden Werte sein.

Fix
Besonderheit
allgemein
Sicherheit

Wenn die Commit -Nachricht diesem Format nicht folgt oder der bereitgestellte type außer den bereitgestellten 4 Typen ist, besteht die Commit -Nachricht Kategorien unter general Typ.

Installation

Installieren Sie die neueste Version mit

$ composer require cshekharsharma/git-changelog

Grundnutzung

 <?php

use GitChangeLog  Constants ;

require_once ' ../vendor/autoload.php ' ;

$ generator = new  GitChangeLog  ChangeLogGenerator ();

$ generator -> setStartDate ( ' 2018-01-01 ' );
$ generator -> setEndDate ( ' 2018-04-01 ' );
$ generator -> setWorkingDir ( ' /path/to/git/repository ' );

$ generator -> setOutputFormat (Constants:: OUTPUT_FORMAT_MARKDOWN );

$ changelogs = $ generator -> generate ();