🚧Improve prepare release process

.github/internal-cicd/deno-tasks/clear-screen.ts

@@ -0,0 +1 @@
+console.clear();

.github/internal-cicd/scripts/update-csharp-proj.ts

@@ -0,0 +1,10 @@
+import { ReleaseType } from "../../../cicd/core/Enums.ts";
+import { CSharpVersionService } from "../../../cicd/core/Services/CSharpVersionService.ts";
+
+const _version = Deno.args[0].trim();
+const _token = Deno.args[1].trim();
+
+const service = new CSharpVersionService("KinsonDigital", "Infrastructure", _token);
+
+await service.updateVersion(_version, ReleaseType.preview);
+

.github/internal-cicd/scripts/update-workflow-versions.ts

@@ -26,7 +26,7 @@ if (!Directory.Exists(baseDirPath)) {
 // Clear the console so the token is not visible from the tasks.json file
 console.clear();
 
-const tagRegex = /v[0-9]+\.[0-9]+\.[0-9]+/gm;
+const tagRegex = /v([1-9]\d*|0)\.([1-9]\d*|0)\.([1-9]\d*|0)(-preview\.([1-9]\d*))?/gm;
 
 const newVersion = await Input.prompt({
 	message: chalk.blue("Enter version to upgrade workflows to:"),
@@ -57,7 +57,7 @@ if (allTags.includes(newVersion)) {
 	Deno.exit(0);
 }
 
-const reusableWorkflowRegex = /uses: .+.(yml|yaml)@v[0-9]+\.[0-9]+\.[0-9]+/gm;
+const reusableWorkflowRegex = /uses: .+.(yml|yaml)@v([1-9]\d*|0)\.([1-9]\d*|0)\.([1-9]\d*|0)(-preview\.([1-9]\d*))?/gm;
 
 const updateMsgs: string[] = [];
 let noFilesUpdated = true;

.github/internal-cicd/scripts/workflow-version-status-check.ts

@@ -33,7 +33,7 @@ const latestTag = (await tagClient.getAllTags())[0].name;
 
 const workflowsToUpdate: WorkflowToUpdate[] = [];
 
-const reusableWorkflowRegex = /uses: .+.(yml|yaml)@v[0-9]+\.[0-9]+\.[0-9]+/gm;
+const reusableWorkflowRegex = /uses: .+.(yml|yaml)@v([1-9]\d*|0)\.([1-9]\d*|0)\.([1-9]\d*|0)(-preview\.([1-9]\d*))?/gm;
 
 type WorkflowToUpdate = {
 	/**

.github/workflows/add-new-item-to-project.yml

@@ -36,7 +36,7 @@ jobs:
   add_new_item_to_project:
     name: Add New Issue
     needs: item_number
-    uses: KinsonDigital/Infrastructure/.github/workflows/add-item-to-project.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/add-item-to-project.yml@v13.5.0
     with:
       org-name: "${{ vars.ORGANIZATION_NAME }}"
       org-project-name: "${{ vars.ORG_PROJECT_NAME }}"

.github/workflows/build-csharp-project.yml

@@ -90,7 +90,7 @@ jobs:
   resolve_proj_file_path:
     name: Resolving ${{ inputs.project-name }} Project File Path
     needs: print_validate_workflow
-    uses: KinsonDigital/Infrastructure/.github/workflows/resolve-csharp-proj-file.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/resolve-csharp-proj-file.yml@v13.5.0
     with:
       project-name: ${{ inputs.project-name }}
       base-path: ${{ inputs.base-path }}

.github/workflows/build-status-check.yml

@@ -30,4 +30,4 @@ jobs:
 
     - name: Run Build
       run: |
-        deno run --allow-read --allow-run "./.github/internal-cicd/scripts/deno-check.ts";
+        deno run --allow-read --allow-run --allow-sys "./.github/internal-cicd/scripts/deno-check.ts";

.github/workflows/dotnet-action-release.yml

@@ -157,7 +157,7 @@ jobs:
   validate_version:
     name: Validate Version
     needs: [print_validate_workflow, validate_branch]
-    uses: KinsonDigital/Infrastructure/.github/workflows/validate-csharp-version.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/validate-csharp-version.yml@v13.5.0
     with:
       project-name: "${{ inputs.project-name }}"
       release-type: "${{ inputs.release-type }}"
@@ -168,7 +168,7 @@ jobs:
   validate_tag:
     name: Validate Tag
     needs: validate_version
-    uses: KinsonDigital/Infrastructure/.github/workflows/validate-tag.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/validate-tag.yml@v13.5.0
     with:
       project-name: "${{ inputs.project-name }}"
       release-type: "${{ inputs.release-type }}"
@@ -207,7 +207,7 @@ jobs:
   validate_github_release:
     name: GitHub Release Does Not Exist
     needs: validate_version
-    uses: KinsonDigital/Infrastructure/.github/workflows/validate-github-release.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/validate-github-release.yml@v13.5.0
     with:
       project-name: "${{ inputs.project-name }}"
       version: "${{ needs.validate_version.outputs.version }}"
@@ -218,7 +218,7 @@ jobs:
   build_project:
     name: Build Main Project (${{ inputs.project-name }})
     needs: print_validate_workflow
-    uses: KinsonDigital/Infrastructure/.github/workflows/build-csharp-project.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/build-csharp-project.yml@v13.5.0
     with:
       project-name: "${{ inputs.project-name }}"
       runs-on: "${{ inputs.runs-on }}"
@@ -231,7 +231,7 @@ jobs:
   run_tests:
     name: Run Tests
     needs: print_validate_workflow
-    uses: KinsonDigital/Infrastructure/.github/workflows/run-csharp-tests.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/run-csharp-tests.yml@v13.5.0
     with:
       project-name: "${{ inputs.project-name }}Tests"
       runs-on: "${{ inputs.runs-on }}"

.github/workflows/dotnet-lib-release.yml

@@ -182,7 +182,7 @@ jobs:
 
   validate_version:
     name: Validate Version
-    uses: KinsonDigital/Infrastructure/.github/workflows/validate-csharp-version.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/validate-csharp-version.yml@v13.5.0
     with:
       project-name: "${{ inputs.project-name }}"
       release-type: "${{ inputs.release-type }}"
@@ -193,7 +193,7 @@ jobs:
   validate_tag:
     name: Validate Tag
     needs: validate_version
-    uses: KinsonDigital/Infrastructure/.github/workflows/validate-tag.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/validate-tag.yml@v13.5.0
     with:
       project-name: "${{ inputs.project-name }}"
       release-type: "${{ inputs.release-type }}"
@@ -205,7 +205,7 @@ jobs:
   nuget_pkg_does_not_exist:
     name: Validate NuGet Package Does Not Exist
     needs: validate_version
-    uses: KinsonDigital/Infrastructure/.github/workflows/nuget-package-does-not-exist.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/nuget-package-does-not-exist.yml@v13.5.0
     with:
       project-name: "${{ inputs.project-name }}"
       version: "${{ needs.validate_version.outputs.version }}"
@@ -214,7 +214,7 @@ jobs:
   validate_milestone_status:
     name: Validate Milestone Status
     needs: validate_version
-    uses: KinsonDigital/Infrastructure/.github/workflows/validate-milestone-status.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/validate-milestone-status.yml@v13.5.0
     with:
       project-name: "${{ inputs.project-name }}"
       version: "${{ needs.validate_version.outputs.version }}"
@@ -225,7 +225,7 @@ jobs:
   validate_github_release:
     name: GitHub Release Does Not Exist
     needs: [validate_version]
-    uses: KinsonDigital/Infrastructure/.github/workflows/validate-github-release.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/validate-github-release.yml@v13.5.0
     with:
       project-name: "${{ inputs.project-name }}"
       version: "${{ needs.validate_version.outputs.version }}"
@@ -236,7 +236,7 @@ jobs:
   build_project:
     name: Build Main Project
     needs: print_validate_workflow
-    uses: KinsonDigital/Infrastructure/.github/workflows/build-csharp-project.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/build-csharp-project.yml@v13.5.0
     with:
       project-name: "${{ inputs.project-name }}"
       runs-on: "${{ inputs.runs-on }}"
@@ -249,7 +249,7 @@ jobs:
   run_tests:
     name: Run Tests
     needs: print_validate_workflow
-    uses: KinsonDigital/Infrastructure/.github/workflows/run-csharp-tests.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/run-csharp-tests.yml@v13.5.0
     with:
       project-name: "${{ inputs.project-name }}Tests"
       runs-on: "${{ inputs.runs-on }}"

.github/workflows/prepare-release-test.yml

@@ -0,0 +1,83 @@
+name: 🚁Prepare Release Test
+run-name: 🚁Prepare ${{ inputs.release-type }} Release Test (${{ inputs.release-version }})
+
+
+defaults:
+  run:
+    shell: pwsh
+
+
+on:
+  workflow_dispatch:
+    inputs:
+      release-type:
+        description: The type of release.  Choose 'Preview' or 'Production'.
+        required: true
+        type: choice
+        options: [Preview, Production]
+      release-version:
+        required: true
+        description: The version of the release to prepare.
+        type: string
+
+
+jobs:
+  print_validate_workflow:
+    name: Print & Validate Prepare Release Workflow
+    runs-on: ubuntu-latest
+    steps:
+      - name: Print Environment Variables
+        run: Get-ChildItem -Path Env:* | Sort-Object Name
+
+      - name: Validate Workflow Inputs
+        run: |
+          $releaseType = "${{ inputs.release-type }}".ToLower();
+
+          if ("${{ vars.PROJECT_NAME }}".Trim() -eq "") {
+            Write-Host "::error::The project name input cannot be empty.";
+            exit 1;
+          }
+
+
+          if ($releaseType -eq "") {
+            Write-Host "::error::The release type input cannot be empty.";
+            exit 1;
+          }
+
+
+          if ($releaseType -ne 'preview' -and $releaseType -ne 'production') {
+            Write-Host "::error::The release type input must be either 'Preview' or 'Production'.";
+            exit 1;
+          }
+
+          $releaseVersion = "${{ inputs.release-version }}".Trim().ToLower();
+
+          if ($releaseVersion -eq "") {
+            Write-Host "::error::The 'release-version' workflow input cannot be empty.";
+            exit 1;
+          }
+
+
+          $prodVersionRegex = "v[0-9]+\.[0-9]+\.[0-9]+";
+          $prevVersionRegex = "v[0-9]+\.[0-9]+\.[0-9]+-preview\.[0-9]+";
+
+          # Verify that the version has valid syntax
+          if (($releaseVersion -match $prodVersionRegex) -or ($releaseVersion -match $prevVersionRegex)) {
+            Write-Host "::notice::The 'release-version' workflow input is valid.";
+          } else {
+            $versionSyntax = $releaseType == "production" ? "v#.#.#" : "v#.#.#-preview.#";
+            Write-Host "::error::The 'release-version' workflow input is not valid.  Expected format: '$versionSyntax";
+            exit 1;
+          }
+
+
+  prepare_release:
+    name: Prepare ${{ inputs.release-type }} Release Of ${{ vars.PROJECT_NAME }}
+    needs: print_validate_workflow
+    uses: KinsonDigital/Infrastructure/.github/workflows/[email protected]
+    with:
+      project-name: "${{ vars.PROJECT_NAME }}"
+      release-type: "${{ inputs.release-type }}"
+      release-version: "${{ inputs.release-version }}"
+    secrets:
+      cicd-pat: ${{ secrets.CICD_TOKEN }}

.github/workflows/prepare-release.yml

@@ -94,8 +94,6 @@ jobs:
           $scriptUrl = $scriptUrl.EndsWith("/") ? $scriptUrl.Substring(0, $scriptUrl.Length - 1) : $scriptUrl;
           $scriptUrl = "$scriptUrl/prepare-release.ts";
 
-          Write-Host "::notice::NuGet Package Check Script URL: $scriptUrl";
-
           <# Deno Args:
             1. Organization name
             2. Project name

.github/workflows/run-csharp-tests.yml

@@ -92,7 +92,7 @@ jobs:
   resolve_proj_file_path:
     name: Resolving ${{ inputs.project-name }} Project File Path
     needs: print_validate_workflow
-    uses: KinsonDigital/Infrastructure/.github/workflows/resolve-csharp-proj-file.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/resolve-csharp-proj-file.yml@v13.5.0
     with:
       project-name: ${{ inputs.project-name }}
       base-path: ${{ inputs.base-path }}

.github/workflows/sync-pr-to-issue.yml

@@ -19,7 +19,7 @@ jobs:
     if: |
       github.event_name == 'pull_request_target' &&
       !startsWith(github.head_ref, 'renovate/')
-    uses: KinsonDigital/Infrastructure/.github/workflows/initial-manual-sync.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/initial-manual-sync.yml@v13.5.0
     with:
       issue-or-pr-number: ${{ github.event.pull_request.number }}
       sync-type: initial
@@ -35,7 +35,7 @@ jobs:
       github.event_name == 'issue_comment' &&
       github.event.issue.pull_request && github.event.issue.pull_request.url != null &&
       contains(github.event.comment.body, '[run-sync]')
-    uses: KinsonDigital/Infrastructure/.github/workflows/initial-manual-sync.yml@v13.4.0
+    uses: KinsonDigital/Infrastructure/.github/workflows/initial-manual-sync.yml@v13.5.0
     with:
       issue-or-pr-number: ${{ github.event.issue.number }}
       sync-type: manual

.vscode/launch.json

@@ -210,9 +210,9 @@
             ],
             "args": [
 				"KinsonDigital",
-				"CASL",
+				"Infrastructure",
 				"preview",
-				"v1.0.0-preview.15",
+				"v1.2.3-preview.4",
 				"${env:CICD_TOKEN}",
 			],
             "attachSimplePort": 9229,
@@ -357,16 +357,15 @@
             "name": "Update CSharp File",
             "request": "launch",
             "type": "node",
-            "program": "${workspaceFolder}/cicd/scripts/update-csharp-proj.ts",
-            "cwd": "${workspaceFolder}/cicd",
+            "program": "${workspaceFolder}/.github/internal-cicd/scripts/update-csharp-proj.ts",
+            "cwd": "${workspaceFolder}",
             "runtimeArgs": [
                 "run",
                 "--inspect-wait",
                 "--allow-all"
             ],
             "args": [
-				"${workspaceFolder}/cicd/test-data/sample-csharp-proj-file.csproj",
-				"v1.0.0-preview.1",
+				"v11.22.33-preview.44",
 				"${env:CICD_TOKEN}",
 			],
             "attachSimplePort": 9229,

.vscode/tasks.json

@@ -7,9 +7,6 @@
 			"label": "clear-terminal",
 			"detail": "Clears the terminal.",
 			"type": "shell",
-			"options": {
-				"cwd": "${workspaceFolder}/.github/cicd"
-			},
 			"windows": {
 				"command": "cls"
 			},

cicd/core/Guard.ts

@@ -9,23 +9,23 @@ export class Guard {
 	 * @param value The value to check.
 	 * @returns True if the value is null, undefined, or empty, otherwise false.
 	 */
-	public static isNullOrEmptyOrUndefined<T>(
+	public static isNothing<T>(
 		value: undefined | null | string | T[] | object,
 		funcName = "",
 		paramName = "",
 	): void {
 		if (Utils.isNothing(value)) {
-			Utils.printAsGitHubError("The value is null, undefined, or empty.");
+			let errorMsg = "The value is null, undefined, or empty.";
 
 			if (funcName != "") {
-				console.log(`Function Name: ${funcName}`);
+				errorMsg += `\nFunction Name: ${funcName}`;
 			}
 
 			if (paramName != "") {
-				console.log(`Param Name: ${paramName}`);
+				errorMsg += `\nParam Name: ${paramName}`;
 			}
 
-			Deno.exit(1);
+			throw new Error(errorMsg);
 		}
 	}
 

cicd/core/ReleaseTweetBuilder.ts

@@ -39,11 +39,11 @@ export class ReleaseTweetBuilder {
 		discordInviteCode: string,
 	): Promise<string> {
 		const funcName = "buildTweet";
-		Guard.isNullOrEmptyOrUndefined(branchName, funcName, "branchName");
-		Guard.isNullOrEmptyOrUndefined(relativeFilePath, funcName, "relativeFilePath");
-		Guard.isNullOrEmptyOrUndefined(projectName, funcName, "projectName");
-		Guard.isNullOrEmptyOrUndefined(version, funcName, "version");
-		Guard.isNullOrEmptyOrUndefined(discordInviteCode, funcName, "discordInviteCode");
+		Guard.isNothing(branchName, funcName, "branchName");
+		Guard.isNothing(relativeFilePath, funcName, "relativeFilePath");
+		Guard.isNothing(projectName, funcName, "projectName");
+		Guard.isNothing(version, funcName, "version");
+		Guard.isNothing(discordInviteCode, funcName, "discordInviteCode");
 
 		version = version.startsWith("v") ? version : `v${version}`;