-
-
Notifications
You must be signed in to change notification settings - Fork 0
ChangelogManager
github-actions edited this page Apr 22, 2026
·
1 revision
Applies changelog mutations and derived release metadata.
- Full name:
\FastForward\DevTools\Changelog\Manager\ChangelogManager - This class is marked as final and can't be subclassed
- This class implements:
\FastForward\DevTools\Changelog\Manager\ChangelogManagerInterface - This class is a Final class
public __construct(\FastForward\DevTools\Filesystem\FilesystemInterface $filesystem, \FastForward\DevTools\Changelog\Parser\ChangelogParserInterface $parser, \FastForward\DevTools\Changelog\Renderer\MarkdownRendererInterface $renderer, \FastForward\DevTools\Git\GitClientInterface $gitClient): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$filesystem |
\FastForward\DevTools\Filesystem\FilesystemInterface | |
$parser |
\FastForward\DevTools\Changelog\Parser\ChangelogParserInterface | |
$renderer |
\FastForward\DevTools\Changelog\Renderer\MarkdownRendererInterface | |
$gitClient |
\FastForward\DevTools\Git\GitClientInterface |
Adds a changelog entry to the selected release section.
public addEntry(string $file, \FastForward\DevTools\Changelog\Entry\ChangelogEntryType $type, string $message, string $version = \FastForward\DevTools\Changelog\Document\ChangelogDocument::UNRELEASED_VERSION, ?string $date = null): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$file |
string | |
$type |
\FastForward\DevTools\Changelog\Entry\ChangelogEntryType | |
$message |
string | |
$version |
string | |
$date |
?string |
Promotes the Unreleased section into a published release.
public promote(string $file, string $version, string $date): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$file |
string | |
$version |
string | |
$date |
string |
Returns the next semantic version inferred from unreleased entries.
public inferNextVersion(string $file, ?string $currentVersion = null): stringParameters:
| Parameter | Type | Description |
|---|---|---|
$file |
string | |
$currentVersion |
?string |
Returns the rendered notes body for a specific released version.
public renderReleaseNotes(string $file, string $version): stringParameters:
| Parameter | Type | Description |
|---|---|---|
$file |
string | |
$version |
string |
Loads and parses the changelog file.
public load(string $file): \FastForward\DevTools\Changelog\Document\ChangelogDocumentParameters:
| Parameter | Type | Description |
|---|---|---|
$file |
string |