0

Final Class Yiisoft\YiiDevTool\App\Command\Release\ReleaseDescription

All Classes | Methods
InheritanceYiisoft\YiiDevTool\App\Command\Release\ReleaseDescription

Public Methods

Hide inherited methods

Method Description Defined By
getBody() Yiisoft\YiiDevTool\App\Command\Release\ReleaseDescription

Method Details

Hide inherited methods

getBody() public method

public string getBody ( string $packageName, Yiisoft\YiiDevTool\Infrastructure\Version $previousVersion, Yiisoft\YiiDevTool\Infrastructure\Version $versionToRelease, string[] $releaseNotes, boolean $hasUpgradeNotes = false )
$packageName string
$previousVersion Yiisoft\YiiDevTool\Infrastructure\Version
$versionToRelease Yiisoft\YiiDevTool\Infrastructure\Version
$releaseNotes string[]
$hasUpgradeNotes boolean 

                public function getBody(
    string $packageName,
    Version $previousVersion,
    Version $versionToRelease,
    array $releaseNotes,
    bool $hasUpgradeNotes = false,
): string {
    $body = implode("\n", $releaseNotes);
    if ($previousVersion->asString() === '') {
        return $body;
    }
    $changelogUrl = "https://github.com/$packageName/compare/$previousVersion...$versionToRelease";
    $body .= "\n\n[Full changelog]($changelogUrl)";
    if ($hasUpgradeNotes && $this->isMajorRelease($versionToRelease)) {
        $upgradeNotesUrl = "https://github.com/$packageName/blob/$versionToRelease/UPGRADE.md";
        $body .= "\n\nSee [UPGRADE.md]($upgradeNotesUrl) for upgrade notes.";
    }
    return $body;
}