UnreleasedEntryChecker

Class
Read only: Yes Final: Yes

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

Table of Contents

Interfaces

UnreleasedEntryCheckerInterface

Verifies that the changelog contains meaningful unreleased changes.

Properties

Methods

__construct()

Constructs a new UnreleasedEntryChecker.

 : mixed
hasPendingChanges()

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

 : bool
flattenEntries()

Flattens release entries for set comparison.

 : array<int, string>
Properties
Methods

hasPendingChanges()

Public

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
$file : string

Description

the changelog file path to inspect

$againstReference : string|null = null

Description

The reference to compare against (e.g., a branch or commit hash).

Return values
bool

Description

true if there are pending unreleased entries, false otherwise