feat: Commit description Regex Replace post processing feature

Author: davola

.changelog

@@ -14,6 +14,8 @@ return [
         '/' . preg_quote($releaseMessagePrefix, '/') . '.*/i',
         '/chore\(changelog\)[:].*/i',
     ],
+    'postProcessRegex' => '/\[([A-Z]{2,3})\-([0-9]+)\]/',
+    'postProcessReplace' => '[[$1-$2]](https://bcvevolve.atlassian.net/browse/$1-$2)',
     'releaseCommitMessageFormat' => "{$releaseMessagePrefix}{{currentTag}}",
     'postRun' => function () use ($releaseMessagePrefix) {
         $lastTag = Repository::getLastTag();

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "marcocesarato/php-conventional-changelog",
     "description": "Generate changelogs and release notes from a project's commit messages and metadata and automate versioning with semver.org and conventionalcommits.org",
-    "version": "1.10.7",
+    "version": "1.10.8",
     "type": "library",
     "license": "GPL-3.0-or-later",
     "minimum-stability": "stable",

src/Changelog.php

@@ -527,7 +527,12 @@ protected function getMarkdownChanges(array $changes): string
                     if (!$this->config->isHiddenMentions() && !empty($mentionsGroup)) {
                         $mentions = '*[*' . implode(', ', $mentionsGroup) . '*]*';
                     }
-                    $changelog .= Formatter::clean("* {$description} {$references} {$sha} {$mentions}");
+                    $itemDescription = Formatter::clean("* {$description} {$references} {$sha} {$mentions}");
+                    if ($this->config->hasPostProcessEnabled()) {
+                        $itemDescription = preg_replace($this->config->getPostProcessRegex(), $this->config->getPostProcessReplace(), $itemDescription);
+                    }
+                    $changelog .= $itemDescription;
+
                     $changelog .= PHP_EOL;
                 }
             }

src/Configuration.php

@@ -259,6 +259,20 @@ class Configuration
      */
     protected $postRun;
 
+    /**
+     * A Regex string to be used on the commit text post processing.
+     *
+     * @var string
+     */
+    protected $postProcessRegex = '';
+
+    /**
+     * A Regex replace string to be used on the commit text post processing.
+     *
+     * @var string
+     */
+    protected $postProcessReplace = '';
+
     /**
      * Constructor.
      */
@@ -307,6 +321,8 @@ public function fromArray(array $array)
             'releaseCommitMessageFormat' => $this->getReleaseCommitMessageFormat(),
             'preRun' => $this->getPreRun(),
             'postRun' => $this->getPostRun(),
+            'postProcessRegex' => $this->getPostProcessRegex(),
+            'postProcessReplace' => $this->getPostProcessReplace(),
         ];
 
         $params = array_replace_recursive($defaults, $array);
@@ -372,7 +388,10 @@ public function fromArray(array $array)
             ->setReleaseCommitMessageFormat($params['releaseCommitMessageFormat'])
             // Hooks
             ->setPreRun($params['preRun'])
-            ->setPostRun($params['postRun']);
+            ->setPostRun($params['postRun'])
+            // Text PostProcessing
+            ->setPostProcessRegex($params['postProcessRegex'])
+            ->setPostProcessReplace($params['postProcessReplace']);
     }
 
     /**
@@ -825,6 +844,41 @@ public function setPostRun($postRun): self
         return $this;
     }
 
+    public function getPostProcessRegex(): string
+    {
+        return $this->postProcessRegex;
+    }
+
+    /**
+     * @param mixed $postProcessRegex
+     */
+    public function setPostProcessRegex($postProcessRegex): self
+    {
+        $this->postProcessRegex = $postProcessRegex;
+
+        return $this;
+    }
+
+    public function getPostProcessReplace(): string
+    {
+        return $this->postProcessReplace;
+    }
+
+    /**
+     * @param mixed $postProcessReplace
+     */
+    public function setPostProcessReplace($postProcessReplace): self
+    {
+        $this->postProcessReplace = $postProcessReplace;
+
+        return $this;
+    }
+
+    public function hasPostProcessEnabled(): bool
+    {
+        return !empty($this->getPostProcessRegex()) && !empty($this->getPostProcessReplace());
+    }
+
     public function isPackageBump(): bool
     {
         return $this->packageBump;