Merge pull request #58 from leviy/include-pre-release-changelogs

Include pre-release changelogs in the changelog of a full release

Author: nicwortel

config/github.yaml

@@ -21,6 +21,7 @@ services:
   github.release_action.release:
     class: Leviy\ReleaseTool\ReleaseAction\GitHubReleaseAction
     arguments:
-      - '@github.client'
-      - '@vcs.git'
+      - '@changelog_generator.pull_request'
       - '@changelog_formatter.markdown'
+      - '@vcs.git'
+      - '@github.client'

config/services.yaml

@@ -12,7 +12,6 @@ services:
     arguments:
       - '@vcs.git'
       - '@versioning_scheme.semantic'
-      - '@changelog_generator.pull_request'
       - ['@github.release_action.release']
 
   versioning_scheme.semantic:
@@ -25,6 +24,11 @@ services:
 
   changelog_formatter.markdown:
     class: Leviy\ReleaseTool\Changelog\Formatter\MarkdownFormatter
+    arguments:
+      - ['@changelog_formatter_filter.markdown.github_pull_request_link']
+
+  changelog_formatter_filter.markdown.github_pull_request_link:
+    class: Leviy\ReleaseTool\Changelog\Formatter\Filter\GitHubPullRequestUrlFilter
     arguments:
       - '%github.owner%/%github.repo%'
 

features/bootstrap/FeatureContext.php

@@ -2,13 +2,18 @@
 declare(strict_types=1);
 
 use Behat\Behat\Context\Context;
-use Leviy\ReleaseTool\Changelog\ChangelogGenerator;
+use Behat\Gherkin\Node\PyStringNode;
+use Leviy\ReleaseTool\Changelog\Formatter\MarkdownFormatter;
+use Leviy\ReleaseTool\Changelog\PullRequestChangelogGenerator;
+use Leviy\ReleaseTool\GitHub\GitHubClient;
 use Leviy\ReleaseTool\Interaction\InformationCollector;
+use Leviy\ReleaseTool\ReleaseAction\GitHubReleaseAction;
 use Leviy\ReleaseTool\ReleaseManager;
+use Leviy\ReleaseTool\Vcs\Commit;
+use Leviy\ReleaseTool\Vcs\Git;
 use Leviy\ReleaseTool\Vcs\VersionControlSystem;
 use Leviy\ReleaseTool\Versioning\SemanticVersioning;
 use Mockery\MockInterface;
-use PHPUnit\Framework\Assert;
 
 class FeatureContext implements Context
 {
@@ -23,29 +28,42 @@ class FeatureContext implements Context
     private $releaseManager;
 
     /**
-     * @var string|null
+     * @var MockInterface|InformationCollector
      */
-    private $nextVersion;
+    private $informationCollector;
 
     /**
-     * @var MockInterface|InformationCollector
+     * @var MockInterface|GitHubClient
      */
-    private $informationCollector;
+    private $githubClient;
+
+    /**
+     * @var Commit[]
+     */
+    private $mergedPullRequests = [];
 
     public function __construct()
     {
         $this->informationCollector = Mockery::mock(InformationCollector::class);
-        $this->versionControlSystem = Mockery::mock(VersionControlSystem::class);
+
+        $this->versionControlSystem = Mockery::mock(Git::class);
         $this->versionControlSystem->shouldIgnoreMissing();
 
-        $changelogGenerator = Mockery::mock(ChangelogGenerator::class);
-        $changelogGenerator->shouldReceive('getChanges')->andReturn([]);
+        $changelogGenerator = new PullRequestChangelogGenerator($this->versionControlSystem);
+
+        $this->githubClient = Mockery::spy(GitHubClient::class);
+
+        $githubReleaseAction = new GitHubReleaseAction(
+            $changelogGenerator,
+            new MarkdownFormatter([]),
+            $this->versionControlSystem,
+            $this->githubClient
+        );
 
         $this->releaseManager = new ReleaseManager(
             $this->versionControlSystem,
             new SemanticVersioning(),
-            $changelogGenerator,
-            []
+            [$githubReleaseAction]
         );
     }
 
@@ -65,7 +83,22 @@ public function iReleaseANewVersion(?string $type = null): void
     {
         $this->selectVersionType($type);
 
-        $this->nextVersion = $this->releaseManager->determineNextVersion($this->informationCollector);
+        $version = $this->releaseManager->determineNextVersion($this->informationCollector);
+        $this->releaseManager->release($version, $this->informationCollector);
+    }
+
+    /**
+     * @When I release version :version
+     */
+    public function iReleaseVersion(string $version): void
+    {
+        $this->versionControlSystem->shouldReceive('getCommitsForVersion')
+            ->with($version, Mockery::any())
+            ->andReturn($this->mergedPullRequests);
+
+        $this->versionControlSystem->shouldReceive('getTagForVersion')->andReturn($version);
+        $this->informationCollector->shouldReceive('askConfirmation')->andReturnTrue();
+        $this->releaseManager->release($version, $this->informationCollector);
     }
 
     /**
@@ -92,16 +125,50 @@ public function iReleaseAPreReleaseVersion(string $preReleaseType, ?string $type
                 return;
         }
 
+        $this->informationCollector->shouldReceive('askConfirmation')->andReturnTrue();
         $this->informationCollector->shouldReceive('askMultipleChoice')->andReturn($answer);
-        $this->nextVersion = $this->releaseManager->determineNextPreReleaseVersion($this->informationCollector);
+
+        $version = $this->releaseManager->determineNextPreReleaseVersion($this->informationCollector);
+        $this->releaseManager->release($version, $this->informationCollector);
     }
 
     /**
      * @Then version :version should be released
      */
     public function versionShouldBeReleased(string $version): void
     {
-        Assert::assertSame($version, $this->nextVersion);
+        $this->versionControlSystem->shouldHaveReceived('createVersion', [$version]);
+    }
+
+    /**
+     * @Given the pre-release :version was created
+     */
+    public function wasAPreRelease(string $version): void
+    {
+        $this->versionControlSystem->shouldReceive('getPreReleasesForVersion')->andReturn([$version]);
+        $this->versionControlSystem->shouldReceive('getCommitsForVersion')
+            ->with($version, Mockery::any())
+            ->andReturn($this->mergedPullRequests);
+
+        $this->mergedPullRequests = [];
+    }
+
+    /**
+     * @Then a release with title :title should be published on GitHub with the following release notes:
+     */
+    public function aReleaseWithTitleShouldBePublishedOnGitHubWithTheFollowingReleaseNotes(
+        string $version,
+        PyStringNode $releaseNotes
+    ) {
+        $this->githubClient->shouldHaveReceived('createRelease', [Mockery::any(), $version, $releaseNotes->getRaw()]);
+    }
+
+    /**
+     * @Given pull request :title with number :number was merged
+     */
+    public function pullRequestWasMerged(string $title, string $number)
+    {
+        $this->mergedPullRequests[] = new Commit('Merge pull request #' . $number . ' from branch', $title);
     }
 
     private function selectVersionType(?string $type): void
@@ -121,6 +188,10 @@ private function selectVersionType(?string $type): void
                 break;
         }
 
+        // Always respond positive to the question "Do you want to push it to the remote repository and perform
+        // additional release steps?"
+        $answers[] = true;
+
         $this->informationCollector->shouldReceive('askConfirmation')->andReturn(...$answers);
     }
 }

features/changelog.feature

@@ -0,0 +1,29 @@
+Feature: Changelog
+
+  Scenario: Releasing a version without any pre-releases
+    Given pull request "Some PR" with number 1 was merged
+    When I release version "1.1.0"
+    Then a release with title "1.1.0" should be published on GitHub with the following release notes:
+      """
+      # Changelog for 1.1.0
+
+      * Some PR (pull request #1)
+
+      """
+
+  Scenario: Releasing a version which is preceded by a pre-release
+    Given pull request "First pull request" with number 1 was merged
+    And the pre-release "1.0.0-beta.1" was created
+    And pull request "Fix bug that came out of beta testing" with number 2 was merged
+    When I release version "1.0.0"
+    Then a release with title "1.0.0" should be published on GitHub with the following release notes:
+      """
+      # Changelog for 1.0.0
+
+      * Fix bug that came out of beta testing (pull request #2)
+
+      # Changelog for 1.0.0-beta.1
+
+      * First pull request (pull request #1)
+
+      """

src/Changelog/Changelog.php

@@ -0,0 +1,60 @@
+<?php
+declare(strict_types=1);
+
+namespace Leviy\ReleaseTool\Changelog;
+
+use function array_keys;
+use function array_merge;
+
+final class Changelog
+{
+    /**
+     * @var string[][]
+     */
+    private $versions = [];
+
+    /**
+     * @var string[]
+     */
+    private $unreleasedChanges = [];
+
+    /**
+     * @return string[]
+     */
+    public function getVersions(): array
+    {
+        return array_keys($this->versions);
+    }
+
+    /**
+     * @param string[] $changes
+     */
+    public function addVersion(string $version, array $changes): void
+    {
+        $this->versions[$version] = $changes;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getChangesForVersion(string $version): array
+    {
+        return $this->versions[$version];
+    }
+
+    /**
+     * @param string[] $unreleasedChanges
+     */
+    public function addUnreleasedChanges(array $unreleasedChanges): void
+    {
+        $this->unreleasedChanges = array_merge($this->unreleasedChanges, $unreleasedChanges);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getUnreleasedChanges(): array
+    {
+        return $this->unreleasedChanges;
+    }
+}

src/Changelog/ChangelogGenerator.php

@@ -3,10 +3,11 @@
 
 namespace Leviy\ReleaseTool\Changelog;
 
+use Leviy\ReleaseTool\Versioning\Version;
+
 interface ChangelogGenerator
 {
-    /**
-     * @return string[]
-     */
-    public function getChanges(): array;
+    public function getUnreleasedChangelog(): Changelog;
+
+    public function getChangelogForVersion(Version $version): Changelog;
 }

src/Changelog/Formatter/Filter/Filter.php

@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+namespace Leviy\ReleaseTool\Changelog\Formatter\Filter;
+
+interface Filter
+{
+    public function filter(string $line): string;
+}

src/Changelog/Formatter/Filter/GitHubPullRequestUrlFilter.php

@@ -0,0 +1,31 @@
+<?php
+declare(strict_types=1);
+
+namespace Leviy\ReleaseTool\Changelog\Formatter\Filter;
+
+use function preg_replace;
+use function sprintf;
+
+final class GitHubPullRequestUrlFilter implements Filter
+{
+    private const PULL_REQUEST_URL = 'https://github.com/%s/pull/$1';
+
+    /**
+     * @var string
+     */
+    private $pullRequestUrl;
+
+    public function __construct(string $repositorySlug)
+    {
+        $this->pullRequestUrl = sprintf(self::PULL_REQUEST_URL, $repositorySlug);
+    }
+
+    public function filter(string $line): string
+    {
+        return preg_replace(
+            '/pull request #(\d+)/',
+            'pull request [#$1](' . $this->pullRequestUrl . ')',
+            $line
+        );
+    }
+}

src/Changelog/Formatter/Filter/IssueLinkFilter.php

@@ -0,0 +1,38 @@
+<?php
+declare(strict_types=1);
+
+namespace Leviy\ReleaseTool\Changelog\Formatter\Filter;
+
+use function preg_replace;
+
+final class IssueLinkFilter implements Filter
+{
+    /**
+     * @var string
+     */
+    private $pattern;
+
+    /**
+     * @var string
+     */
+    private $url;
+
+    /**
+     * @param string $pattern A regular expression pattern for issue references
+     * @param string $url     A URL replacement string
+     */
+    public function __construct(string $pattern, string $url)
+    {
+        $this->pattern = $pattern;
+        $this->url = $url;
+    }
+
+    public function filter(string $line): string
+    {
+        return preg_replace(
+            $this->pattern,
+            '[$1](' . $this->url . ')',
+            $line
+        );
+    }
+}

src/Changelog/Formatter/Formatter.php

@@ -3,12 +3,9 @@
 
 namespace Leviy\ReleaseTool\Changelog\Formatter;
 
+use Leviy\ReleaseTool\Changelog\Changelog;
+
 interface Formatter
 {
-    /**
-     * @param string[] $changes
-     *
-     * @return string[]
-     */
-    public function formatChanges(array $changes): array;
+    public function format(Changelog $changelog): string;
 }