OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	05/19/2025 10:07:21 AM	rwxr-xr-x
📄 ChangelogBuilder.php	5.43 KB	05/19/2025 10:07:21 AM	rw-r--r--
📄 build-changelog.php	392 bytes	05/19/2025 10:07:21 AM	rw-r--r--

Editing: ChangelogBuilder.php

<?php
namespace Aws\Build\Changelog;

/**
 * @internal
 */
class ChangelogBuilder
{
    /** @var boolean */
    private $verbose;

/** @var string */
    private $releaseNotesOutputDir;

/** @var string */
    private $baseDir;

/** @var boolean */
    private $newServiceFlag = false;

const CHANGELOG_FEATURE = 'feature';
    const CHANGELOG_API_CHANGE = 'api-change';
    const CHANGELOG_ENHANCEMENT = 'enhancement';
    const CHANGELOG_BUGFIX = 'bugfix';
    const CHANGELOG_DOCUMENTATION = 'documentation';

/**
     *  The constructor requires following configure parameters:
     * - base_dir: (String) Path to the base directory where the `.changes` folder is located. Default is empty string.
     * - release_notes_output_dir: (String) Path to `.changes` folder where new release json will be put and content of
     *                              `nextrelease` folder will be deleted
     * - verbose: (Boolean) Flag to enable(true)/disable(false) verbose mode
     */
    public function __construct(array $params)
    {
        $this->baseDir = isset($params['base_dir']) ? $params['base_dir'] : '';
        $this->releaseNotesOutputDir = isset($params['release_notes_output_dir'])
            ? $params['release_notes_output_dir']
            : '';
        $this->verbose = isset($params['verbose']) ? $params['verbose'] : false;
    }

public function isNewService()
    {
        return $this->newServiceFlag;
    }

private function readChangelog()
    {
        $releaseDir = $this->baseDir . '.changes/nextrelease/';
        $changelogEntries = [];
        if (!is_dir($releaseDir) || !$dh = opendir($releaseDir)) {
            throw new \InvalidArgumentException(
                "nextrelease directory doesn't exists or is not readable at location $releaseDir"
            );
        }
        //Ignore any files starting with a (.) dot
        $files = preg_grep('/^([^.])/', scandir($releaseDir));
        if (empty($files)) {
            throw new \InvalidArgumentException("No release notes files found in $releaseDir folder");
        }
        foreach ($files as $file) {
            $str = file_get_contents($releaseDir . $file);
            $changelogEntries = array_merge($changelogEntries, $this->cleanJSON(json_decode($str)));
        }
        closedir($dh);

$this->newServiceFlag = count(array_filter($changelogEntries, function ($change) {
                return $change->type === self::CHANGELOG_FEATURE;
            })) > 0;

return $changelogEntries;
    }

private function cleanJSON($arr)
    {
        if (empty($arr) || !is_array($arr)) {
            throw new \RuntimeException('Invalid Input', 2);
        }

return $arr;
    }

private function createTag($changelogFile)
    {
        if (!file_exists($changelogFile)) {
            throw new \RuntimeException('Changelog File Not Found', 2);
        }
        $lines = file($changelogFile);
        $tag = explode(".", explode(" ", $lines[2])[1]);
        if ($tag[0] == 'next') {
            throw new \InvalidArgumentException('Untagged changes exits in CHANGELOG.md', 1);
        }
        if ($this->newServiceFlag) {
            //Minor Version Bump if a newservice is being released
            ++$tag[1];
            $tag[2] = 0;
        } else {
            ++$tag[2];
        }

return implode(".", $tag);
    }

private function createChangelogJson($changelog, $tag)
    {
        $fp = fopen($this->releaseNotesOutputDir . ".changes/" . $tag, 'w');
        fwrite($fp, json_encode($changelog, JSON_PRETTY_PRINT) . PHP_EOL);
        fclose($fp);
    }

private function writeToChangelog($changelog, $changelogFile)
    {
        if (!file_exists($changelogFile)) {
            throw new \InvalidArgumentException('Changelog File Not Found', 2);
        }
        $newChangeLog = "## next release\n\n" . $changelog . "\n";
        $lines = file($changelogFile);
        $lines[2] = $newChangeLog . $lines[2];
        file_put_contents($changelogFile, $lines);
    }

public function cleanNextReleaseFolder()
    {
        $nextReleaseDir = $this->baseDir . '.changes/nextrelease/';
        $files = preg_grep('/^([^.])/', scandir($nextReleaseDir));
        foreach ($files as $file) {
            if (is_file($nextReleaseDir . $file)) {
                unlink($nextReleaseDir . $file);
            }
        }
    }

private function generateChangelogString($changelog)
    {
        usort($changelog, function ($a, $b) {
            return strcmp($a->category, $b->category);
        });
        $str = "";
        foreach ($changelog as $log) {
            $str .= "* `Aws\\" . $log->category . "` - " . $log->description . "\n";
        }
        return $str;
    }

public function buildChangelog()
    {
        $changelogFile = $this->baseDir . 'CHANGELOG.md';
        $newChangelog = $this->readChangelog();
        $tag = $this->createTag($changelogFile);
        putenv("TAG=$tag");
        if ($this->verbose) {
            echo 'Tag for next release ' . $tag . "\n";
        }
        $this->createChangelogJson($newChangelog, $tag);
        $ChangelogUpdate = $this->generateChangelogString($newChangelog);
        if ($this->verbose) {
            echo "$ChangelogUpdate";
        }
        $this->writeToChangelog($ChangelogUpdate, $this->releaseNotesOutputDir . 'CHANGELOG.md');
    }
}