Verifies that the changelog contains pending unreleased notes.
'changelog:check'
'Checks whether a changelog file contains meaningful unreleased entries.'
'This command validates the current Unreleased section and may compare it against a base git reference to enforce pull request changelog updates.'
Interfaces
Defines the logger contract consumed by reusable command result helpers.
Properties
Methods
Adds the standard JSON output options to the current command.
Configures changelog verification options.
Executes the changelog verification.
Determines whether JSON output was requested.
Determines whether pretty JSON output was requested.
Logs a failed command result and returns the failure exit code.
Logs an informational command message at notice level.
Logs a successful command result and returns the success exit code.
private
FilesystemInterface
$filesystem
private
LoggerInterface
$logger
private
UnreleasedEntryCheckerInterface
$unreleasedEntryChecker
public
__construct(FilesystemInterface
$filesystem, UnreleasedEntryCheckerInterface
$unreleasedEntryChecker, LoggerInterface
$logger) : mixed
Parameters
$logger
:
LoggerInterface
Adds the standard JSON output options to the current command.
protected
addJsonOption() : static
Return values
Configures changelog verification options.
protected
configure() : void
Executes the changelog verification.
protected
execute(InputInterface
$input, OutputInterface
$output) : int
Parameters
$input
:
InputInterface
$output
:
OutputInterface
Return values
Determines whether JSON output was requested.
protected
isJsonOutput(InputInterface
$input) : bool
Description
The pretty-json flag SHALL imply JSON output.
Parameters
$input
:
InputInterface
Return values
Determines whether pretty JSON output was requested.
protected
isPrettyJsonOutput(InputInterface
$input) : bool
Parameters
$input
:
InputInterface
Return values
Logs a failed command result and returns the failure exit code.
private
failure(
string
$message, InputInterface
$input[,
array<string, mixed>
$context = []][,
string|null
$file = null][,
int|null
$line = null]) : int
Parameters
$message
:
string
Description
the failure message
$input
:
InputInterface
Description
the originating command input
$context
:
array<string, mixed>
=
[]
Description
optional extra log context
$file
:
string|null
=
null
Description
the related file path when known
$line
:
int|null
=
null
Description
the related line when known
Return values
Logs an informational command message at notice level.
private
notice(
string
$message, InputInterface
$input[,
array<string, mixed>
$context = []]) : void
Parameters
$message
:
string
Description
the notice message
$input
:
InputInterface
Description
the originating command input
$context
:
array<string, mixed>
=
[]
Description
optional extra log context
Logs a successful command result and returns the success exit code.
private
success(
string
$message, InputInterface
$input[,
array<string, mixed>
$context = []][,
string
$logLevel = LogLevel::INFO]) : int
Parameters
$message
:
string
Description
the success message
$input
:
InputInterface
Description
the originating command input
$context
:
array<string, mixed>
=
[]
Description
optional extra log context
$logLevel
:
string
=
LogLevel::INFO
Description
the PSR-3 log level used for the successful result