ChangelogBuilder
in package
FinalYes
Table of Contents
Methods
- buildReleaseNotes() : array{notes: string, previous_tag: ?string}
- updateChangelog() : string
- categorizeSubject() : array{section: string, description: string}
- containsMeaningfulContent() : bool
- isEmptySections() : bool
- renderSections() : string
Methods
buildReleaseNotes()
public
buildReleaseNotes(array<int, string> $subjects[, string|null $previousTag = null ]) : array{notes: string, previous_tag: ?string}
Parameters
- $subjects : array<int, string>
- $previousTag : string|null = null
Return values
array{notes: string, previous_tag: ?string}updateChangelog()
public
updateChangelog(string $existingChangelog, string $version, string $releaseDate, string $notes) : string
Parameters
- $existingChangelog : string
- $version : string
- $releaseDate : string
- $notes : string
Return values
stringcategorizeSubject()
private
categorizeSubject(string $subject) : array{section: string, description: string}
Parameters
- $subject : string
Return values
array{section: string, description: string}containsMeaningfulContent()
private
containsMeaningfulContent(array<int, string> $lines) : bool
Parameters
- $lines : array<int, string>
Return values
boolisEmptySections()
private
isEmptySections(array<string, array<int, string>> $sections) : bool
Parameters
- $sections : array<string, array<int, string>>
Return values
boolrenderSections()
private
renderSections(array<string, array<int, string>> $sections) : string
Parameters
- $sections : array<string, array<int, string>>