fix semver regex (#62)

Closes #61

Reviewed-on: https://git.justinelmore.dev/jelmore1674/build-changelog/pulls/62
Co-authored-by: Justin Elmore <[email protected]>
Co-committed-by: Justin Elmore <[email protected]>

Author: jelmore1674

changelog/author.yml

@@ -0,0 +1,11 @@
+version: 1.4.0
+release_date: 2025-01-02
+author: Justin Elmore
+
+added:
+  feature:
+    - Author linking inside of action! 🚀
+
+references:
+  - type: pull_request
+    reference: 62

changelog/regex.yml

@@ -0,0 +1,13 @@
+version: 1.4.0
+release_date: 2025-01-02
+author: Justin Elmore
+
+fixed:
+  bug:
+    - Resolve bug where versions with more than 1 digit was not being parsed correctly.
+
+references:
+  - type: issue
+    reference: 61
+  - type: pull_request
+    reference: 62

generate/index.js

@@ -1,6 +1,6 @@
 {
   "name": "@jelmore1674/build-changelog",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "",
   "main": "dist/index.js",
   "files": [

notes/index.js

@@ -10,7 +10,7 @@ const program = new Command();
 program
   .name("build-changelog")
   .description("cli tool to generate changelogs")
-  .version("1.3.1");
+  .version("1.4.0");
 
 program
   .command("init")

package.json

@@ -12,6 +12,7 @@ import { rl } from "./readline";
 
 const GITHUB_SERVER_URL = process.env.GITHUB_SERVER_URL;
 const GITHUB_REPOSITORY = process.env.GITHUB_REPOSITORY;
+const GITHUB_ACTOR = process.env.GITHUB_ACTOR;
 
 /** Properties we will not use when adding changes to the changelog */
 const YAML_KEY_FILTER = ["release_date", "version", "notice", "references", "author"];
@@ -121,6 +122,15 @@ function generateReferences(references: Reference[]): string {
   }).join(", ");
 }
 
+/**
+ * Generate the link for the author.
+ *
+ * @param author - author name.
+ */
+function generateAuthorLink(author: string) {
+  return `[${author}](${GITHUB_SERVER_URL}/${GITHUB_ACTOR})`;
+}
+
 /**
  *  The generate command will read the existing `yaml|yml` files in the
  *  `changelogDir`, write them to the `CHANGELOG.md`, and will remove the
@@ -193,7 +203,11 @@ function generateCommand() {
 
                   // Add author to the change.
                   if (author) {
-                    renderedChange = `${renderedChange} (${author})`;
+                    if (GITHUB_ACTOR) {
+                      renderedChange = `${renderedChange} (${generateAuthorLink(author)})`;
+                    } else {
+                      renderedChange = `${renderedChange} (${author})`;
+                    }
                   }
 
                   if (config.flags?.[flag]) {

src/index.ts

@@ -1,9 +1,13 @@
 import { existsSync, readFileSync } from "node:fs";
-import path from "node:path";
 import { Keywords, Version } from "./mustache";
 
-// semver versioning
-const versionRegex = /\d\.\d\.\d/gism;
+/**
+ * semver versioning.
+ * Regex is from [semver](https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string)
+ * The only change from semver is added check for unreleased.
+ */
+const versionRegex =
+  /((0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?|unreleased)/gism;
 // release version section.
 const versionSectionRegex = /(?=^#{2} .*?$)/gism;
 // date: looks for either 2024-12-06 or 12-06-2024
@@ -58,7 +62,7 @@ function parseChangelog(changelogPath: string) {
             "",
           ).trim().split("\n- ")
             .map((change: string) =>
-              change.replace(/^\[(\d\.\d\.\d|unreleased).*/gism, "")
+              change.replace(/^\[(\d{1,4}\.\d{1,4}\.\d{1,4}|unreleased).*/gism, "")
                 .replace(/^- /g, "")
                 .replace(/\n /g, "")
                 .trim()