feat: add ability to control the value to prefix the notes with

schemas/prepare-release-schema.json

@@ -33,6 +33,10 @@
         "versionJSONKeyPath": {
             "type": "string",
             "description": "The path to the version number in the JSON file. Only used if the file is a JSON file. (Optional)"
+        },
+        "releaseNotesFilePrefix": {
+            "type": "string",
+            "description": "The path to the version number in the JSON file. Only used if the file is a JSON file. (Optional)"
         }
     },
     "required": ["ownerName", "repoName", "releaseTypes", "githubTokenEnvVarName"]

src/prepare-release-settings.ts

@@ -39,4 +39,9 @@ export interface PrepareReleaseSettings {
 	 * Gets the dot separated path to the JSON key that contains the version.
 	 */
 	versionJSONKeyPath?: string;
+
+	/**
+	 * Gets the value to prefix the release notes file name with.
+	 */
+	releaseNotesFilePrefix?: string;
 }

src/release-prepper.ts

@@ -154,7 +154,11 @@ export class ReleasePrepper {
 		}
 
 		// Generate the release notes
-		const newNotesFilePath = await this.createReleaseNotes(chosenReleaseType, chosenVersion, settings.githubTokenEnvVarName);
+		const newNotesFilePath = await this.createReleaseNotes(
+			chosenReleaseType,
+			chosenVersion,
+			settings.githubTokenEnvVarName,
+			settings.releaseNotesFilePrefix);
 
 		// If release notes were generated, stage and commit them.
 		if (newNotesFilePath !== undefined) {
@@ -447,16 +451,24 @@ export class ReleasePrepper {
 		}
 	}
 
+	/**
+	 * Creates release notes based on the given {@link releaseType} and {@link chosenVersion}.
+	 * @param releaseType The type of release.
+	 * @param chosenVersion The version.
+	 * @param tokenEnvVarName The name of the environment variable that contains the GitHub token.
+	 * @param fileNamePrefix The value to prefix the notes file name with.
+	 * @returns The release notes.
+	 */
 	private async createReleaseNotes(
 		releaseType: ReleaseType,
 		chosenVersion: string,
 		tokenEnvVarName: string,
+		fileNamePrefix?: string,
 	): Promise<string | undefined> {
 		ConsoleLogColor.gray("   ⏳Creating release notes.");
 
 		// Trim the notes dir path and replace all '\' with '/'
-		let notesDirPath = releaseType.releaseNotesDirPath.trim()
-			.replace(/\\/g, "/");
+		let notesDirPath = releaseType.releaseNotesDirPath.trim().replace(/\\/g, "/");
 
 		notesDirPath = notesDirPath.endsWith("/") ? notesDirPath.slice(0, -1) : notesDirPath;
 
@@ -475,7 +487,9 @@ export class ReleasePrepper {
 			Deno.mkdirSync(notesDirPath, { recursive: true });
 		}
 
-		const newNotesFilePath = `${notesDirPath}/Release-Notes-${chosenVersion}.md`;
+		const prefix = Guards.isNothing(fileNamePrefix) ? "" : fileNamePrefix;
+
+		const newNotesFilePath = `${notesDirPath}/${prefix}${chosenVersion}.md`;
 
 		Deno.writeTextFileSync(newNotesFilePath, releaseNotesFileContent, { create: true });