Add new option to parse and linkify GitHub Usernames (#41)

* Add parse-github-usernames option

* Add test

* Add implementation

* Add docs for --parse-github-usernames

Author: stefanzweifel

README.md

@@ -85,6 +85,14 @@ Optional. Tell the CLI explicitly to use the content between an "Unreleased Head
 ### `--hide-release-date`
 Optional. Don't add the release date to the release heading.
 
+### `--parse-github-usernames` (experimental 🧪)
+Optional. Look for GitHub usernames in `--release-notes` and linkify them. Currently not supported for release notes that are located in the existing changelog.
+
+```diff
+- Added a new feature @stefanzweifel
++ Added a new feature [@stefanzweifel](https://github.com/stefanzweifel)
+```
+
 ## Expected Changelog Formats
 
 The CLI does its best to place the given release notes in the right place. 

app/Actions/ParseAndLinkifyGitHubUsernamesAction.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Actions;
+
+class ParseAndLinkifyGitHubUsernamesAction
+{
+    public function execute(?string $releaseNotes): ?string
+    {
+        if ($releaseNotes === null) {
+            return null;
+        }
+
+        // Pattern explanation:
+        // - `(?<!\[)` and `(?!\])` are negative lookbehind and lookahead assertions, respectively.
+        //   They ensure that the GitHub username is not preceded or followed by a square
+        //   bracket [ or ], which indicates that the username is already wrapped in a link.
+        // - `@([A-Za-z0-9_]+)` matches the GitHub username itself. It starts with
+        //   the @ symbol and consists of alphanumeric characters and underscores.
+        $pattern = '/(?<!\[)@([A-Za-z0-9_]+)(?!\])/';
+
+        $replacement = '[@$1](https://github.com/$1)';
+
+        return preg_replace($pattern, $replacement, $releaseNotes);
+    }
+}

app/Commands/UpdateCommand.php

@@ -5,6 +5,7 @@
 namespace App\Commands;
 
 use App\Actions\AddReleaseNotesToChangelogAction;
+use App\Actions\ParseAndLinkifyGitHubUsernamesAction;
 use App\Exceptions\ReleaseAlreadyExistsInChangelogException;
 use App\Exceptions\ReleaseNotesCanNotBeplacedException;
 use App\Exceptions\ReleaseNotesNotProvidedException;
@@ -26,6 +27,7 @@ class UpdateCommand extends Command
         {--compare-url-target-revision=HEAD : Target revision used in the compare URL of possible "Unreleased" heading.}
         {--github-actions-output : Display GitHub Actions related output}
         {--hide-release-date : Hide release date in the new release heading.}
+        {--parse-github-usernames : Experimental: Find GitHub usernames in release notes and link to their profile.}
         {-w\--write : Write changes to file}
     ';
 
@@ -34,7 +36,7 @@ class UpdateCommand extends Command
     /**
      * @throws Throwable
      */
-    public function handle(AddReleaseNotesToChangelogAction $addReleaseNotesToChangelog, GitHubActionsOutput $gitHubActionsOutput)
+    public function handle(AddReleaseNotesToChangelogAction $addReleaseNotesToChangelog, GitHubActionsOutput $gitHubActionsOutput, ParseAndLinkifyGitHubUsernamesAction $parseAndLinkifyGitHubUsernames)
     {
         $latestVersion = $this->option('latest-version') ?: $this->ask('What version should the CHANGELOG be updated too?');
         $releaseNotes = $this->getReleaseNotes();
@@ -55,8 +57,13 @@ public function handle(AddReleaseNotesToChangelogAction $addReleaseNotesToChange
             $headingText = $latestVersion;
         }
 
+        if ($this->option('parse-github-usernames')) {
+            $releaseNotes = $parseAndLinkifyGitHubUsernames->execute($releaseNotes);
+        }
+
         $changelog = $this->getChangelogContent($pathToChangelog);
 
+
         try {
             $updatedChangelog = $addReleaseNotesToChangelog->execute(
                 originalChangelog: $changelog,

tests/Feature/UpdateCommandTest.php

@@ -487,3 +487,25 @@
         ->expectsOutput(file_get_contents(__DIR__ . '/../Stubs/expected-changelog-without-unreleased-without-date.md'))
         ->assertSuccessful();
 });
+
+it('parses github usernames and links to their github user profiles', function () {
+    $this->artisan(UpdateCommand::class, [
+        '--release-notes' => <<<MD
+        ### Added
+        - New Feature A @stefanzweifel
+        - New Feature B [@stefanzweifel](https://github.com/stefanzweifel)
+
+        ### Changed
+        - Update Feature C
+
+        ### Removes
+        - Remove Feature D
+        MD,
+        '--latest-version' => 'v1.0.0',
+        '--path-to-changelog' => __DIR__ . '/../Stubs/base-changelog.md',
+        '--release-date' => '2021-02-01',
+        '--parse-github-usernames' => true,
+    ])
+        ->expectsOutput(file_get_contents(__DIR__ . '/../Stubs/expected-changelog-with-parsed-github-usernames.md'))
+        ->assertSuccessful();
+});

tests/Stubs/expected-changelog-with-parsed-github-usernames.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased](https://github.com/org/repo/compare/v1.0.0...HEAD)
+
+Please do not update the unreleased notes.
+
+<!-- Content should be placed here -->
+## [v1.0.0](https://github.com/org/repo/compare/v0.1.0...v1.0.0) - 2021-02-01
+
+### Added
+
+- New Feature A [@stefanzweifel](https://github.com/stefanzweifel)
+- New Feature B [@stefanzweifel](https://github.com/stefanzweifel)
+
+### Changed
+
+- Update Feature C
+
+### Removes
+
+- Remove Feature D
+
+## v0.1.0 - 2021-01-01
+
+### Added
+
+- Initial Release

tests/Unit/Actions/ParseAndLinkifyGitHubUsernamesActionTest.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+use App\Actions\ParseAndLinkifyGitHubUsernamesAction;
+
+it('returns null if release notes are null also', function () {
+
+    $result = app(ParseAndLinkifyGitHubUsernamesAction::class)->execute(null);
+
+    expect($result)->toBeNull();
+});
+
+it('does not replace anything if there are no GitHub usernames in string', function () {
+
+    $result = app(ParseAndLinkifyGitHubUsernamesAction::class)->execute('This is a string with no GitHub usernames.');
+
+    expect($result)->toEqual('This is a string with no GitHub usernames.');
+});
+
+it('replaces GitHub usernames with links', function () {
+
+    $result = app(ParseAndLinkifyGitHubUsernamesAction::class)->execute('This is a string with a @username in it.');
+
+    expect($result)->toEqual('This is a string with a [@username](https://github.com/username) in it.');
+});