Skip to content

ChangelogManager

github-actions edited this page Apr 22, 2026 · 1 revision

Applies changelog mutations and derived release metadata.


Methods

__construct

public __construct(\FastForward\DevTools\Filesystem\FilesystemInterface $filesystem, \FastForward\DevTools\Changelog\Parser\ChangelogParserInterface $parser, \FastForward\DevTools\Changelog\Renderer\MarkdownRendererInterface $renderer, \FastForward\DevTools\Git\GitClientInterface $gitClient): mixed

Parameters:

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

addEntry

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): void

Parameters:

Parameter Type Description
$file string
$type \FastForward\DevTools\Changelog\Entry\ChangelogEntryType
$message string
$version string
$date ?string

promote

Promotes the Unreleased section into a published release.

public promote(string $file, string $version, string $date): void

Parameters:

Parameter Type Description
$file string
$version string
$date string

inferNextVersion

Returns the next semantic version inferred from unreleased entries.

public inferNextVersion(string $file, ?string $currentVersion = null): string

Parameters:

Parameter Type Description
$file string
$currentVersion ?string

renderReleaseNotes

Returns the rendered notes body for a specific released version.

public renderReleaseNotes(string $file, string $version): string

Parameters:

Parameter Type Description
$file string
$version string

load

Loads and parses the changelog file.

public load(string $file): \FastForward\DevTools\Changelog\Document\ChangelogDocument

Parameters:

Parameter Type Description
$file string

Clone this wiki locally