Auto-linking of issues and usernames in CHANGELOG during the build

Author: halaxa

CHANGELOG.md

@@ -14,7 +14,7 @@ Nothing yet
 
 ## 1.2.4 - 2025-06-16
 ### Fixed
-- The key of a scalar value after a compound value is lost (#125). Thanks [@smiletoeverybody](https://github.com/smiletoeverybody)
+- The key of a scalar value after a compound value is lost ([#125](https://github.com/halaxa/json-machine/issues/125)). Thanks [@smiletoeverybody](https://github.com/smiletoeverybody)
 
 <br>
 
@@ -27,14 +27,14 @@ Standard parsing speed boost (non-recursive, non-debug) about + 50 %. Further im
 
 ## 1.2.2 - 2025-04-30
 ### Changed
-- Leaner release package (#124). Thanks [@robotomarvin](https://github.com/robotomarvin)
+- Leaner release package ([#124](https://github.com/halaxa/json-machine/issues/124)). Thanks [@robotomarvin](https://github.com/robotomarvin)
 
 <br>
 
 ## 1.2.1 - 2025-04-25
 ### Fixed
-- File autoloading without composer (#122). Thanks [@bahco](https://github.com/bahco)
-- Crash on `null` value in `RecursiveItems` (#119). Thanks [@bark92](https://github.com/bark92)
+- File autoloading without composer ([#122](https://github.com/halaxa/json-machine/issues/122)). Thanks [@bahco](https://github.com/bahco)
+- Crash on `null` value in `RecursiveItems` ([#119](https://github.com/halaxa/json-machine/issues/119)). Thanks [@bark92](https://github.com/bark92)
 <br>
 
 ## 1.2.0 - 2024-11-24
@@ -48,7 +48,7 @@ Standard parsing speed boost (non-recursive, non-debug) about + 50 %. Further im
 - Support for PHP 8.4
 - Exception on misspelled option name suggests a correct one. 
 ### Fixed
-- Wrong key when combining list and scalar value pointers (#110). Thanks [@daniel-sc](https://github.com/daniel-sc)
+- Wrong key when combining list and scalar value pointers ([#110](https://github.com/halaxa/json-machine/issues/110)). Thanks [@daniel-sc](https://github.com/daniel-sc)
 ### Removed
 - Removed support for PHP 7.0, 7.1
 <br>
@@ -59,13 +59,13 @@ Standard parsing speed boost (non-recursive, non-debug) about + 50 %. Further im
 - Support for PHP 8.3
 - Added PHPStan to build pipeline
 ### Fixed
-- Fixed the case when non-intersecting pointers were considered intersecting (#106). Thanks [@XedinUnknown](https://github.com/XedinUnknown)
+- Fixed the case when non-intersecting pointers were considered intersecting ([#106](https://github.com/halaxa/json-machine/issues/106)). Thanks [@XedinUnknown](https://github.com/XedinUnknown)
 
 <br>
 
 ## 1.1.3 - 2022-10-12
 ### Fixed
-- Fix the parsing of nested sub-trees that use wildcards (#83). Thanks [@cerbero90](https://github.com/cerbero90)
+- Fix the parsing of nested sub-trees that use wildcards ([#83](https://github.com/halaxa/json-machine/issues/83)). Thanks [@cerbero90](https://github.com/cerbero90)
 
 <br>
 
@@ -74,8 +74,8 @@ Standard parsing speed boost (non-recursive, non-debug) about + 50 %. Further im
 - PHP 8.2 support
 
 ### Fixed
-- Meaningful error on invalid token. (#86)
-- Added missing return type annotation. (#84)
+- Meaningful error on invalid token. ([#86](https://github.com/halaxa/json-machine/issues/86))
+- Added missing return type annotation. ([#84](https://github.com/halaxa/json-machine/issues/84))
 
 <br>
 
@@ -174,7 +174,7 @@ https://stackoverflow.com/questions/63706550
 
 ## 0.6.1
 ### Fixed bugs
-- Empty dict at the end of an item was causing Syntax error in the next item. Reason: closing `}` did not set object key expectation to `false`. (#41 via PR #42).
+- Empty dict at the end of an item was causing Syntax error in the next item. Reason: closing `}` did not set object key expectation to `false`. ([#41](https://github.com/halaxa/json-machine/issues/41) via PR [#42](https://github.com/halaxa/json-machine/issues/42)).
 
 <br>
 

build/update-changelog.php

@@ -11,13 +11,42 @@
     exit(1);
 }
 
-$releaseDate = date('Y-m-d');
-$changelogMatch = '## master';
-$changelogReplace = "$changelogMatch
+$changelogContents = addReleaseHeading($changelogContents, $version);
+$changelogContents = linkifyUsernames($changelogContents);
+$changelogContents = linkifyIssues($changelogContents);
+
+file_put_contents($changelogPath, $changelogContents);
+
+
+
+function addReleaseHeading(string $changelogContents, $version): string
+{
+    $releaseDate = date('Y-m-d');
+    $changelogMatch = '## master';
+    $changelogReplace = "$changelogMatch
 Nothing yet
 
 <br>
 
 ## $version - $releaseDate";
 
-file_put_contents($changelogPath, str_replace($changelogMatch, $changelogReplace, $changelogContents));
+    return str_replace($changelogMatch, $changelogReplace, $changelogContents);
+}
+
+function linkifyUsernames(string $changelogContents): string
+{
+    return preg_replace(
+        '/([^\[]\s*)@([a-zA-Z-]+)(\s*[^\]])/',
+        '$1[@$2](https://github.com/$2)$3',
+        $changelogContents
+    );
+}
+
+function linkifyIssues(string $changelogContents): string
+{
+    return preg_replace(
+        '/([^\[]\s*)#(\d+)(\s*[^\]])/',
+        '$1[#$2](https://github.com/halaxa/json-machine/issues/$2)$3',
+        $changelogContents
+    );
+}