Add --compare-url-target-revision option (#13)

* Update Dependencies

* Add --compare-url-target-revision option

* Add Stubs for Tests

* Delete unused .gitkeep

* Add Test

* Use $compareUrlTarget

* Update README

Author: stefanzweifel

README.md

@@ -38,10 +38,11 @@ php changelog-updater update \
 --latest-version="v1.0.0" \
 --release-date="2021-08-07" \
 --path-to-changelog="CHANGELOG.md" \
+--compare-url-target-revision="1.x"
 --write
 ```
 
-`--release-date`, `--path-to-changelog` and `--write` are optional. Learn more about the options by running `php changelog-updater update --help`.
+`--release-date`, `--path-to-changelog`, `--compare-url-target-revision` and `--write` are optional. Learn more about the options by running `php changelog-updater update --help`.
 
 ### CLI Options
 
@@ -59,6 +60,9 @@ Optional (Defaults to current date). The date the latest version has been releas
 ### `--path-to-changelog`
 Optional (Defaults to `CHANGELOG.md`). Path to CHANGELOG.md file.
 
+### `--compare-url-target-revision`
+Optional (Defaults to `HEAD`). If the changelog has a "Unreleased" heading, the value will be used together with the `--latest-version` value in the updated compare URL.
+
 ### `--write`
 Optional. Write the changes to `CHANGELOG.md` or to the value of `--path-to-changelog`.
 

app/Actions/AddReleaseNotesToChangelog.php

@@ -35,14 +35,21 @@ public function __construct(
     /**
      * @throws Throwable
      */
-    public function execute(string $originalChangelog, string $releaseNotes, string $latestVersion, string $releaseDate): RenderedContentInterface
+    public function execute(string $originalChangelog, string $releaseNotes, string $latestVersion, string $releaseDate, string $compareUrlTargetRevision): RenderedContentInterface
     {
         $changelog = $this->markdownParser->parse($originalChangelog);
 
         $unreleasedHeading = $this->findUnreleasedHeading->find($changelog);
 
         if ($unreleasedHeading !== null) {
-            $changelog = $this->pasteReleaseNotesBelowUnreleasedHeading->execute($unreleasedHeading, $latestVersion, $releaseDate, $releaseNotes, $changelog);
+            $changelog = $this->pasteReleaseNotesBelowUnreleasedHeading->execute(
+                unreleasedHeading: $unreleasedHeading,
+                latestVersion: $latestVersion,
+                releaseDate: $releaseDate,
+                releaseNotes: $releaseNotes,
+                changelog: $changelog,
+                compareUrlTargetRevision: $compareUrlTargetRevision
+            );
         } else {
             $changelog = $this->pasteReleaseNotesAtTheTop->execute($latestVersion, $releaseNotes, $releaseDate, $changelog);
         }

app/Actions/PasteReleaseNotesBelowUnreleasedHeading.php

@@ -37,11 +37,11 @@ public function __construct(
     /**
      * @throws Throwable
      */
-    public function execute(Heading $unreleasedHeading, string $latestVersion, string $releaseDate, string $releaseNotes, Document $changelog): Document
+    public function execute(Heading $unreleasedHeading, string $latestVersion, string $releaseDate, string $releaseNotes, Document $changelog, string $compareUrlTargetRevision): Document
     {
         $previousVersion = $this->getPreviousVersionFromUnreleasedHeading($unreleasedHeading);
         $repositoryUrl = $this->getRepositoryUrlFromUnreleasedHeading($unreleasedHeading);
-        $updatedUrl = $this->generateCompareUrl->generate($repositoryUrl, $latestVersion, 'HEAD');
+        $updatedUrl = $this->generateCompareUrl->generate($repositoryUrl, $latestVersion, $compareUrlTargetRevision);
 
         $link = $this->getLinkNodeFromHeading($unreleasedHeading);
         $link->setUrl($updatedUrl);

app/Commands/.gitkeep

@@ -13,10 +13,11 @@
 class UpdateCommand extends Command
 {
     protected $signature = 'update
-        {--release-notes= : Markdown Release Notes to be added to the CHANGELOG}
-        {--latest-version= : The version the CHANGELOG should be updated too}
+        {--release-notes= : Markdown Release Notes to be added to the CHANGELOG.}
+        {--latest-version= : The version the CHANGELOG should be updated too.}
         {--release-date= : Date when latest version has been released. Defaults to today.}
-        {--path-to-changelog=CHANGELOG.md : Path to changelog markdown file to be updated}
+        {--path-to-changelog=CHANGELOG.md : Path to changelog markdown file to be updated.}
+        {--compare-url-target-revision=HEAD : Target revision used in the compare URL of possible "Unreleased" heading.}
         {-w\--write : Write changes to file}
     ';
 
@@ -33,6 +34,7 @@ public function handle(AddReleaseNotesToChangelog $addReleaseNotesToChangelog):
         $latestVersion = $this->option('latest-version');
         $releaseDate = $this->option('release-date');
         $pathToChangelog = $this->option('path-to-changelog');
+        $compareUrlTargetRevision = $this->option('compare-url-target-revision');
 
         if (empty($releaseDate)) {
             $releaseDate = now()->format('Y-m-d');
@@ -44,7 +46,8 @@ public function handle(AddReleaseNotesToChangelog $addReleaseNotesToChangelog):
             originalChangelog: $changelog,
             releaseNotes: $releaseNotes,
             latestVersion: $latestVersion,
-            releaseDate: $releaseDate
+            releaseDate: $releaseDate,
+            compareUrlTargetRevision: $compareUrlTargetRevision
         );
 
         $this->info($updatedChangelog->getContent());

app/Commands/UpdateCommand.php

@@ -39,7 +39,10 @@
     "config": {
         "preferred-install": "dist",
         "sort-packages": true,
-        "optimize-autoloader": true
+        "optimize-autoloader": true,
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
     },
     "scripts": {
         "build": "php changelog-updater app:build",