-
-
Notifications
You must be signed in to change notification settings - Fork 0
ChangelogDocument
github-actions edited this page Apr 20, 2026
·
1 revision
Represents the minimal Keep a Changelog document structure used by dev-tools.
- Full name:
\FastForward\DevTools\Changelog\Document\ChangelogDocument - This class is marked as final and can't be subclassed
- This class is a Final class
| Constant | Visibility | Type | Value |
|---|---|---|---|
UNRELEASED_VERSION |
public | 'Unreleased' |
public __construct(list<\FastForward\DevTools\Changelog\Document\ChangelogRelease> $releases): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$releases |
list<\FastForward\DevTools\Changelog\Document\ChangelogRelease> |
Creates a new document with an empty Unreleased section.
public static create(): self- This method is static.
Returns the release sections in document order.
public getReleases(): list<\FastForward\DevTools\Changelog\Document\ChangelogRelease>Returns the Unreleased section, creating an empty one when needed.
public getUnreleased(): \FastForward\DevTools\Changelog\Document\ChangelogReleaseReturns the requested release section when present.
public getRelease(string $version): ?\FastForward\DevTools\Changelog\Document\ChangelogReleaseParameters:
| Parameter | Type | Description |
|---|---|---|
$version |
string |
Returns the newest published release section when available.
public getLatestPublishedRelease(): ?\FastForward\DevTools\Changelog\Document\ChangelogReleaseReturns a copy with the provided release inserted or replaced.
public withRelease(\FastForward\DevTools\Changelog\Document\ChangelogRelease $target): selfParameters:
| Parameter | Type | Description |
|---|---|---|
$target |
\FastForward\DevTools\Changelog\Document\ChangelogRelease |
Returns a copy with the unreleased entries promoted into a published release.
public promoteUnreleased(string $version, string $date): selfParameters:
| Parameter | Type | Description |
|---|---|---|
$version |
string | |
$date |
string |