Skip to content

UnreleasedEntryChecker

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

Compares unreleased changelog entries against the current branch or a base ref.


Methods

__construct

Constructs a new UnreleasedEntryChecker.

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

Parameters:

Parameter Type Description
$filesystem \FastForward\DevTools\Filesystem\FilesystemInterface
$gitClient \FastForward\DevTools\Git\GitClientInterface the Git client used for baseline inspection
$parser \FastForward\DevTools\Changelog\Parser\ChangelogParserInterface

hasPendingChanges

Checks if there are pending unreleased entries in the changelog compared to a given reference.

public hasPendingChanges(string $file, string|null $againstReference = null): bool

Parameters:

Parameter Type Description
$file string the changelog file path to inspect
$againstReference string|null The reference to compare against (e.g., a branch or commit hash).

Return Value:

true if there are pending unreleased entries, false otherwise


Clone this wiki locally