Add support for appending health check metadata to gauge results (#2)

* build: Add tooling for code quality

* build: Update build tool

* test: Update test class

Bumped target framework to .NET 8, updated dependencies and added analyzers

* test(sample): Update the SampleApi project to latest dependencies and .NET 8

* chore: Apply dotnet format to solution

* build: Refactor build tool application host

Also, add new build target to launch code coverage reports in browser.

* build: Refactor git hooks

Also minor edits to github pipelines and build tool comments

* feat(metrics): Add support for appending health check metadata to guage results

Add XmlDoc to public classes and some additional build properties to help with CI.
Reduce the version on the dependency to allow greater compatibility with older .NET 6 projects.

+semver: minor

* chore(sample): Update sample project to be more descriptive

Author: gowon

.config/dotnet-tools.json

@@ -2,16 +2,22 @@
   "version": 1,
   "isRoot": true,
   "tools": {
+    "gitversion.tool": {
+      "version": "5.12.0",
+      "commands": [
+        "dotnet-gitversion"
+      ]
+    },
     "dotnet-reportgenerator-globaltool": {
-      "version": "5.1.25",
+      "version": "5.2.4",
       "commands": [
         "reportgenerator"
       ]
     },
-    "gitversion.tool": {
-      "version": "5.12.0",
+    "husky": {
+      "version": "0.6.4",
       "commands": [
-        "dotnet-gitversion"
+        "husky"
       ]
     }
   }

.editorconfig

@@ -0,0 +1 @@
+*.sh text eol=lf

.gitattributes

@@ -47,9 +47,9 @@ jobs:
           fetch-depth: 0
           ref: dev
 
-      - uses: actions/setup-dotnet@v3
+      - uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: '7.x'
+          dotnet-version: '8.x'
 
       - name: Build solution
         run: dotnet run --project build/build.csproj --configuration Release -- targets pack

.github/workflows/nightly-build.yaml

@@ -36,7 +36,6 @@ bld/
 .vs/
 # Uncomment if you have tasks that create the project's static files in wwwroot
 #wwwroot/
-.artifacts/
 
 # Visual Studio 2017 auto generated files
 Generated\ Files/
@@ -397,3 +396,6 @@ FodyWeavers.xsd
 
 # JetBrains Rider
 *.sln.iml
+
+# Include Husky.Net scripts
+!.husky/csx

.gitignore

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# $1 = temp file containing commit message
+dotnet husky run --group "commit-msg" --args "$1"

.husky/commit-msg

@@ -0,0 +1,51 @@
+#r "System.Linq"
+#r "System.Text.RegularExpressions"
+#load "common.csx"
+
+using System;
+using System.ComponentModel;
+using System.IO;
+using System.Linq;
+using System.Text.RegularExpressions;
+using static Constants;
+using static Utilities;
+
+private static void Log(string message)
+{
+    Console.WriteLine($"[append-issue-id] {message}");
+}
+
+var branchName = Args[0];
+var branchMatch = Regex.Match(branchName, RegexPatterns.BranchName, RegexOptions.IgnoreCase);
+var issue = branchMatch.Groups["issue"];
+var commitMessage = File.ReadAllText(Args[1]);
+commitMessage = NormalizeNewlineFeeds(commitMessage);
+var commitMatch = Regex.Match(commitMessage, RegexPatterns.CommitMessage, RegexOptions.Multiline);
+var footers = commitMatch.Groups["footers"];
+
+// skip if no issue ID detected
+if (!issue.Success || issue.Value.Equals("no-ref"))
+{
+    Log($"{UnicodeEmojis.Information} No issue ID detected in branch name.");
+    return 0;
+}
+
+// does the commit message have a footer
+if (footers.Success)
+{
+    // does the footer already contain a reference to the issue
+    if (footers.Value.Contains(issue.Value))
+    {
+        Log($"{UnicodeEmojis.Information} Issue #{issue.Value} detected in commit message.");
+        return 0;
+    }
+
+    File.AppendAllText(Args[1], Environment.NewLine + $"Refs: #{issue.Value}");
+}
+else
+{
+    File.AppendAllText(Args[1], Environment.NewLine + Environment.NewLine + $"Refs: #{issue.Value}");
+}
+
+Log($"{UnicodeEmojis.Success} Appended reference for issue #{issue.Value} to commit message!");
+return 0;

.husky/csx/append-issue-id.csx

@@ -0,0 +1,33 @@
+#r "System.Text.RegularExpressions"
+
+using System.Text.RegularExpressions;
+
+public static class Constants
+{
+    public static class RegexPatterns
+    {
+        // ref: https://regex101.com/r/ZgMPsl/2
+        // language=regex
+        public static readonly string CommitMessage = @"\A(?:(?<type>[^\(!:]+)(?:\((?<scope>[^\)]+)\))?(?<breaking>!)?: (?<description>.+))(?:(?!(?:\n{2}^(?:BREAKING[ -]CHANGE|[a-zA-Z0-9_\-]+)(?:: | #\b)[^\n:]+(\n*\b)?)+)\n{2}(?<body>(?:(?!\n{2}(?:^(?:BREAKING[ -]CHANGE|[a-zA-Z0-9_\-]+)(?:: | #\b)[^\n:]+(\n*\b)?)+).|\n+?)+?))?(?:\n{2}(?<footers>(?:^(?:BREAKING[ -]CHANGE|[a-zA-Z0-9_\-]+)(?:: | #\b)[^\n:]+(\n*\b)?)+))?(?:\n*)\Z";
+
+        // ref: https://regex101.com/r/Y34fz1/4
+        // language=regex
+        public static readonly string BranchName = @"^(?:(?<type>main|dev(?:elop)?)|(?<type>release)\/(?<version>[0-9]+(?:\.[0-9]+){2}(?:-[a-zA-Z0-9]+)?)|(?<type>wip)\/(?<desc>[a-zA-Z0-9]+(?:[-][a-zA-Z0-9]+)*)|(?<type>feature|(?:bug|hot)fix)\/(?<issue>[0-9]+|no-ref){1}\/(?<desc>[a-zA-Z0-9]+(?:[-][a-zA-Z0-9]+)*))$";
+    }
+
+    public static class UnicodeEmojis
+    {
+        public static readonly string Success = "\u2714"; // check_mark = ✔
+        public static readonly string Failure = "\u274c"; // cross_mark = ❌
+        public static readonly string Information = "\u2139"; // information = ℹ
+        public static readonly string Warning = "\u26a0"; // warning = ⚠
+    }
+}
+
+public static class Utilities
+{
+    public static string NormalizeNewlineFeeds(string message)
+    {
+        return Regex.Replace(message, @"\r\n|\r|\n", "\n");
+    }
+}

.husky/csx/common.csx

@@ -0,0 +1,42 @@
+#r "System.Linq"
+#r "System.Text.RegularExpressions"
+#load "common.csx"
+
+using System.ComponentModel;
+using System.Linq;
+using System.Text.RegularExpressions;
+using static Constants;
+
+private static void Log(string message)
+{
+    Console.WriteLine($"[lint-branch-name] {message}");
+}
+
+var branchName = Args[0];
+var match = Regex.Match(branchName, RegexPatterns.BranchName, RegexOptions.IgnoreCase);
+
+if (!match.Success)
+{
+    Log($"{UnicodeEmojis.Failure} branch name is invalid!");
+    Log("Please review the docs for more information about the branch naming conventions.");
+    return 1;
+}
+
+switch (match.Groups["type"].Value)
+{
+    case "feature":
+    case "bugfix":
+    case "hotfix":
+    case "wip":
+        if (match.Groups["desc"].Value.Length < 4)
+        {
+            Log($"{UnicodeEmojis.Failure} branch name is invalid!");
+            Log("The 'description' segment of the branch name must be at least 4 characters long.");
+            Log("Please review the docs for more information about the branch naming conventions.");
+            return 1;
+        }
+        break;
+}
+
+Log($"{UnicodeEmojis.Success} branch name is valid!");
+return 0;

.husky/csx/lint-branch-name.csx

@@ -0,0 +1,26 @@
+#r "System.Text.RegularExpressions"
+#load "common.csx"
+
+using System.Text.RegularExpressions;
+using static Constants;
+using static Utilities;
+
+private static void Log(string message)
+{
+    Console.WriteLine($"[lint-commit-msg] {message}");
+}
+
+var commitMessage = File.ReadAllText(Args[0]);
+commitMessage = NormalizeNewlineFeeds(commitMessage);
+
+if (Regex.IsMatch(commitMessage, RegexPatterns.CommitMessage, RegexOptions.Multiline))
+{
+    Log($"{UnicodeEmojis.Success} commit message format is valid!");
+    return 0;
+}
+
+Log($"{UnicodeEmojis.Failure} commit message format is invalid!");
+Log("e.g: 'feat(scope): subject' or 'fix: subject'");
+Log("more info: https://www.conventionalcommits.org/en/v1.0.0/");
+
+return 1;