Merge pull request #40 from weierophinney/feature/33-bump-changelog

Ocramius · web-flow · commit 6e9cab016f3e · 2020-08-12T16:50:21.000+02:00
When a new release is made, bump the CHANGELOG version in the next release branch and the originating release branch
diff --git a/.github/workflows/automatic-release.yml b/.github/workflows/automatic-release.yml
@@ -45,3 +45,13 @@ jobs:
           "SIGNING_SECRET_KEY": ${{ secrets.SIGNING_SECRET_KEY }}
           "GIT_AUTHOR_NAME": ${{ secrets.GIT_AUTHOR_NAME }}
           "GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}
+
+      - name: "Bump Changelog Version On Originating Release Branch"
+        uses: "./"
+        with:
+          command-name: "laminas:automatic-releases:bump-changelog"
+        env:
+          "GITHUB_TOKEN": ${{ secrets.ORGANIZATION_ADMIN_TOKEN }}
+          "SIGNING_SECRET_KEY": ${{ secrets.SIGNING_SECRET_KEY }}
+          "GIT_AUTHOR_NAME": ${{ secrets.GIT_AUTHOR_NAME }}
+          "GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 1.2.0 - TBD
+
+### Added
+
+- [#40](https://github.com/laminas/automatic-releases/pull/40) adds a new command, laminas:automatic-releases:bump-changelog. When a `CHANGELOG.md` file is present in the repository, it will add an entry in the file for the next patch-level release to the target branch of the closed milestone. The patch also adds the command to the end of the suggested workflow configuration.
+
+### Changed
+
+- [#40](https://github.com/laminas/automatic-releases/pull/40) updates the laminas:automatic-releases:switch-default-branch-to-next-minor command such that if a `CHANGELOG.md` file is present in the repository, and a new minor release branch is created, it adds an entry to the file for the next minor release.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
 ## 1.1.0 - 2020-08-06
 
 ### Added
diff --git a/bin/console.php b/bin/console.php
@@ -8,11 +8,14 @@
 use ErrorException;
 use Http\Discovery\HttpClientDiscovery;
 use Http\Discovery\Psr17FactoryDiscovery;
+use Laminas\AutomaticReleases\Application\Command\BumpChangelogForReleaseBranch;
 use Laminas\AutomaticReleases\Application\Command\CreateMergeUpPullRequest;
 use Laminas\AutomaticReleases\Application\Command\ReleaseCommand;
 use Laminas\AutomaticReleases\Application\Command\SwitchDefaultBranchToNextMinor;
+use Laminas\AutomaticReleases\Changelog\BumpAndCommitChangelogVersionViaKeepAChangelog;
 use Laminas\AutomaticReleases\Changelog\CommitReleaseChangelogViaKeepAChangelog;
 use Laminas\AutomaticReleases\Environment\EnvironmentVariables;
+use Laminas\AutomaticReleases\Git\CheckoutBranchViaConsole;
 use Laminas\AutomaticReleases\Git\CommitFileViaConsole;
 use Laminas\AutomaticReleases\Git\CreateTagViaConsole;
 use Laminas\AutomaticReleases\Git\FetchAndSetCurrentUserByReplacingCurrentOriginRemote;
@@ -66,6 +69,7 @@ static function (int $errorCode, string $message = '', string $file = '', int $l
         $httpClient,
         $githubToken
     ));
+    $checkoutBranch       = new CheckoutBranchViaConsole();
     $commit               = new CommitFileViaConsole();
     $push                 = new PushViaConsole();
     $commitChangelog      = new CommitReleaseChangelogViaKeepAChangelog(new SystemClock(), $commit, $push, $logger);
@@ -82,6 +86,12 @@ static function (int $errorCode, string $message = '', string $file = '', int $l
         $httpClient,
         $githubToken
     );
+    $bumpChangelogVersion = new BumpAndCommitChangelogVersionViaKeepAChangelog(
+        $checkoutBranch,
+        $commit,
+        $push,
+        $logger
+    );
 
     /** @psalm-suppress DeprecatedClass */
     $application = new Application(Versions::ROOT_PACKAGE_NAME, Versions::getVersion('laminas/automatic-releases'));
@@ -123,7 +133,15 @@ static function (int $errorCode, string $message = '', string $file = '', int $l
                 $makeRequests,
                 $httpClient,
                 $githubToken
-            )
+            ),
+            $bumpChangelogVersion
+        ),
+        new BumpChangelogForReleaseBranch(
+            $variables,
+            $loadEvent,
+            $fetch,
+            $getCandidateBranches,
+            $bumpChangelogVersion
         ),
     ]);
 
diff --git a/examples/.github/workflows/release-on-milestone-closed.yml b/examples/.github/workflows/release-on-milestone-closed.yml
@@ -45,3 +45,13 @@ jobs:
           "SIGNING_SECRET_KEY": ${{ secrets.SIGNING_SECRET_KEY }}
           "GIT_AUTHOR_NAME": ${{ secrets.GIT_AUTHOR_NAME }}
           "GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}
+
+      - name: "Bump Changelog Version On Originating Release Branch"
+        uses: "laminas/automatic-releases@v1"
+        with:
+          command-name: "laminas:automatic-releases:bump-changelog"
+        env:
+          "GITHUB_TOKEN": ${{ secrets.ORGANIZATION_ADMIN_TOKEN }}
+          "SIGNING_SECRET_KEY": ${{ secrets.SIGNING_SECRET_KEY }}
+          "GIT_AUTHOR_NAME": ${{ secrets.GIT_AUTHOR_NAME }}
+          "GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}
diff --git a/src/Application/Command/BumpChangelogForReleaseBranch.php b/src/Application/Command/BumpChangelogForReleaseBranch.php
@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Laminas\AutomaticReleases\Application\Command;
+
+use Laminas\AutomaticReleases\Changelog\BumpAndCommitChangelogVersion;
+use Laminas\AutomaticReleases\Environment\Variables;
+use Laminas\AutomaticReleases\Git\Fetch;
+use Laminas\AutomaticReleases\Git\GetMergeTargetCandidateBranches;
+use Laminas\AutomaticReleases\Github\Event\Factory\LoadCurrentGithubEvent;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Webmozart\Assert\Assert;
+
+use function sprintf;
+
+final class BumpChangelogForReleaseBranch extends Command
+{
+    private Variables $environment;
+    private LoadCurrentGithubEvent $loadEvent;
+    private Fetch $fetch;
+    private GetMergeTargetCandidateBranches $getMergeTargets;
+    private BumpAndCommitChangelogVersion $bumpChangelogVersion;
+
+    public function __construct(
+        Variables $environment,
+        LoadCurrentGithubEvent $loadEvent,
+        Fetch $fetch,
+        GetMergeTargetCandidateBranches $getMergeTargets,
+        BumpAndCommitChangelogVersion $bumpChangelogVersion
+    ) {
+        parent::__construct('laminas:automatic-releases:bump-changelog');
+
+        $this->environment          = $environment;
+        $this->loadEvent            = $loadEvent;
+        $this->fetch                = $fetch;
+        $this->getMergeTargets      = $getMergeTargets;
+        $this->bumpChangelogVersion = $bumpChangelogVersion;
+    }
+
+    public function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $milestoneClosedEvent = ($this->loadEvent)();
+        $repositoryName       = $milestoneClosedEvent->repository();
+        $repositoryCloneUri   = $repositoryName->uriWithTokenAuthentication($this->environment->githubToken());
+        $repositoryPath       = $this->environment->githubWorkspacePath();
+
+        Assert::directory($repositoryPath . '/.git');
+
+        ($this->fetch)($repositoryCloneUri, $repositoryPath);
+
+        $mergeCandidates = ($this->getMergeTargets)($repositoryPath);
+        $releaseVersion  = $milestoneClosedEvent->version();
+        $releaseBranch   = $mergeCandidates->targetBranchFor($releaseVersion);
+
+        Assert::notNull(
+            $releaseBranch,
+            sprintf('No valid release branch found for version %s', $releaseVersion->fullReleaseName())
+        );
+
+        ($this->bumpChangelogVersion)(
+            BumpAndCommitChangelogVersion::BUMP_PATCH,
+            $repositoryPath,
+            $releaseVersion,
+            $releaseBranch
+        );
+
+        return 0;
+    }
+}
diff --git a/src/Application/Command/SwitchDefaultBranchToNextMinor.php b/src/Application/Command/SwitchDefaultBranchToNextMinor.php
@@ -4,6 +4,7 @@
 
 namespace Laminas\AutomaticReleases\Application\Command;
 
+use Laminas\AutomaticReleases\Changelog\BumpAndCommitChangelogVersion;
 use Laminas\AutomaticReleases\Environment\Variables;
 use Laminas\AutomaticReleases\Git\Fetch;
 use Laminas\AutomaticReleases\Git\GetMergeTargetCandidateBranches;
@@ -23,23 +24,26 @@ final class SwitchDefaultBranchToNextMinor extends Command
     private GetMergeTargetCandidateBranches $getMergeCandidates;
     private Push $push;
     private SetDefaultBranch $switchDefaultBranch;
+    private BumpAndCommitChangelogVersion $bumpChangelogVersion;
 
     public function __construct(
         Variables $variables,
         LoadCurrentGithubEvent $loadGithubEvent,
         Fetch $fetch,
         GetMergeTargetCandidateBranches $getMergeCandidates,
         Push $push,
-        SetDefaultBranch $switchDefaultBranch
+        SetDefaultBranch $switchDefaultBranch,
+        BumpAndCommitChangelogVersion $bumpChangelogVersion
     ) {
         parent::__construct('laminas:automatic-releases:switch-default-branch-to-next-minor');
 
-        $this->variables           = $variables;
-        $this->loadGithubEvent     = $loadGithubEvent;
-        $this->fetch               = $fetch;
-        $this->getMergeCandidates  = $getMergeCandidates;
-        $this->push                = $push;
-        $this->switchDefaultBranch = $switchDefaultBranch;
+        $this->variables            = $variables;
+        $this->loadGithubEvent      = $loadGithubEvent;
+        $this->fetch                = $fetch;
+        $this->getMergeCandidates   = $getMergeCandidates;
+        $this->push                 = $push;
+        $this->switchDefaultBranch  = $switchDefaultBranch;
+        $this->bumpChangelogVersion = $bumpChangelogVersion;
     }
 
     public function execute(InputInterface $input, OutputInterface $output): int
@@ -73,6 +77,12 @@ public function execute(InputInterface $input, OutputInterface $output): int
                 $newestBranch->name(),
                 $nextDefaultBranch->name()
             );
+            ($this->bumpChangelogVersion)(
+                BumpAndCommitChangelogVersion::BUMP_MINOR,
+                $repositoryPath,
+                $releaseVersion,
+                $newestBranch
+            );
         }
 
         $this->switchDefaultBranch->__invoke($event->repository(), $nextDefaultBranch);
diff --git a/src/Changelog/BumpAndCommitChangelogVersion.php b/src/Changelog/BumpAndCommitChangelogVersion.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Laminas\AutomaticReleases\Changelog;
+
+use Laminas\AutomaticReleases\Git\Value\BranchName;
+use Laminas\AutomaticReleases\Git\Value\SemVerVersion;
+
+interface BumpAndCommitChangelogVersion
+{
+    public const BUMP_MINOR = 'bumpMinorVersion';
+    public const BUMP_PATCH = 'bumpPatchVersion';
+
+    /**
+     * @psalm-param self::BUMP_*     $bumpType
+     * @psalm-param non-empty-string $repositoryDirectory
+     */
+    public function __invoke(
+        string $bumpType,
+        string $repositoryDirectory,
+        SemVerVersion $version,
+        BranchName $sourceBranch
+    ): void;
+}
diff --git a/src/Changelog/BumpAndCommitChangelogVersionViaKeepAChangelog.php b/src/Changelog/BumpAndCommitChangelogVersionViaKeepAChangelog.php
@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Laminas\AutomaticReleases\Changelog;
+
+use Laminas\AutomaticReleases\Git\CheckoutBranch;
+use Laminas\AutomaticReleases\Git\CommitFile;
+use Laminas\AutomaticReleases\Git\Push;
+use Laminas\AutomaticReleases\Git\Value\BranchName;
+use Laminas\AutomaticReleases\Git\Value\SemVerVersion;
+use Phly\KeepAChangelog\Bump\ChangelogBump;
+use Psr\Log\LoggerInterface;
+use Webmozart\Assert\Assert;
+
+use function file_exists;
+use function sprintf;
+
+class BumpAndCommitChangelogVersionViaKeepAChangelog implements BumpAndCommitChangelogVersion
+{
+    private const CHANGELOG_FILE = 'CHANGELOG.md';
+
+    private const COMMIT_TEMPLATE = <<< 'COMMIT'
+        Bumps changelog version to %s
+
+        Updates the %s file to add a changelog entry for a new %s version.
+        COMMIT;
+
+    private CheckoutBranch $checkoutBranch;
+    private CommitFile $commitFile;
+    private Push $push;
+    private LoggerInterface $logger;
+
+    public function __construct(
+        CheckoutBranch $checkoutBranch,
+        CommitFile $commitFile,
+        Push $push,
+        LoggerInterface $logger
+    ) {
+        $this->checkoutBranch = $checkoutBranch;
+        $this->commitFile     = $commitFile;
+        $this->push           = $push;
+        $this->logger         = $logger;
+    }
+
+    public function __invoke(
+        string $bumpType,
+        string $repositoryDirectory,
+        SemVerVersion $version,
+        BranchName $sourceBranch
+    ): void {
+        ($this->checkoutBranch)($repositoryDirectory, $sourceBranch);
+
+        $changelogFile = sprintf('%s/%s', $repositoryDirectory, self::CHANGELOG_FILE);
+        if (! file_exists($changelogFile)) {
+            // No changelog
+            $this->logger->info('BumpAndCommitChangelog: No CHANGELOG.md file detected');
+
+            return;
+        }
+
+        $versionString = $version->fullReleaseName();
+        $bumper        = new ChangelogBump($changelogFile);
+        $newVersion    = $bumper->$bumpType($versionString);
+
+        Assert::stringNotEmpty($newVersion);
+        $bumper->updateChangelog($newVersion);
+
+        ($this->commitFile)(
+            $repositoryDirectory,
+            $sourceBranch,
+            self::CHANGELOG_FILE,
+            sprintf(self::COMMIT_TEMPLATE, $newVersion, self::CHANGELOG_FILE, $newVersion)
+        );
+
+        ($this->push)($repositoryDirectory, $sourceBranch->name());
+
+        $this->logger->info(sprintf(
+            'BumpAndCommitChangelog: bumped %s to version %s in branch %s',
+            self::CHANGELOG_FILE,
+            $newVersion,
+            $sourceBranch->name()
+        ));
+    }
+}
diff --git a/src/Git/CheckoutBranch.php b/src/Git/CheckoutBranch.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Laminas\AutomaticReleases\Git;
+
+use Laminas\AutomaticReleases\Git\Value\BranchName;
+
+interface CheckoutBranch
+{
+    /**
+     * @psalm-param non-empty-string $repositoryDirectory
+     */
+    public function __invoke(
+        string $repositoryDirectory,
+        BranchName $branchName
+    ): void;
+}
diff --git a/src/Git/CheckoutBranchViaConsole.php b/src/Git/CheckoutBranchViaConsole.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Laminas\AutomaticReleases\Git;
+
+use Laminas\AutomaticReleases\Git\Value\BranchName;
+use Symfony\Component\Process\Process;
+
+class CheckoutBranchViaConsole implements CheckoutBranch
+{
+    public function __invoke(
+        string $repositoryDirectory,
+        BranchName $branchName
+    ): void {
+        (new Process(['git', 'switch', $branchName->name()], $repositoryDirectory))
+            ->mustRun();
+    }
+}
diff --git a/test/unit/Application/BumpChangelogForReleaseBranchTest.php b/test/unit/Application/BumpChangelogForReleaseBranchTest.php
diff --git a/test/unit/Application/ReleaseCommandTest.php b/test/unit/Application/ReleaseCommandTest.php
diff --git a/test/unit/Application/SwitchDefaultBranchToNextMinorTest.php b/test/unit/Application/SwitchDefaultBranchToNextMinorTest.php
diff --git a/test/unit/Changelog/BumpAndCommitChangelogVersionViaKeepAChangelogTest.php b/test/unit/Changelog/BumpAndCommitChangelogVersionViaKeepAChangelogTest.php
diff --git a/test/unit/Git/CheckoutBranchViaConsoleTest.php b/test/unit/Git/CheckoutBranchViaConsoleTest.php
