Pre-release cleanup: config alignment, build scripts, docs fix, whitespace (#96)

* Initial plan

* Apply improvements from agent reviews: fix docs, configs, build scripts, whitespace

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>

Author: Copilot

.editorconfig

@@ -6,6 +6,7 @@ root = true
 # All files
 [*]
 charset = utf-8
+end_of_line = lf
 indent_style = space
 indent_size = 4
 insert_final_newline = true

.markdownlint-cli2.jsonc

@@ -4,6 +4,7 @@
     "MD003": { "style": "atx" },
     "MD007": { "indent": 2 },
     "MD013": { "line_length": 120 },
+    "MD025": false,
     "MD033": false,
     "MD041": false
   },

build.bat

@@ -1,16 +1,16 @@
 @echo off
 setlocal
 
-REM Restore dependencies
-dotnet restore
-if errorlevel 1 exit /b 1
-
-REM Build the project
+echo Building BuildMark...
 dotnet build --configuration Release
 if errorlevel 1 exit /b 1
 
-REM Run tests
+echo Running unit tests...
 dotnet test --configuration Release
 if errorlevel 1 exit /b 1
 
-echo Build completed successfully!
+echo Running self-validation...
+dotnet run --project src/DemaConsulting.BuildMark --configuration Release --framework net10.0 --no-build -- --validate
+if errorlevel 1 exit /b 1
+
+echo Build, tests, and validation completed successfully!

build.sh

@@ -1,11 +1,13 @@
 #!/bin/bash
 set -e
 
-# Restore dependencies
-dotnet restore
-
-# Build the project
+echo "🔧 Building BuildMark..."
 dotnet build --configuration Release
 
-# Run tests
+echo "🧪 Running unit tests..."
 dotnet test --configuration Release
+
+echo "✅ Running self-validation..."
+dotnet run --project src/DemaConsulting.BuildMark --configuration Release --framework net10.0 --no-build -- --validate
+
+echo "✨ Build, tests, and validation completed successfully!"

docs/guide/guide.md

@@ -350,11 +350,10 @@ The self-validation suite includes the following tests that verify core function
 
 | Test Name | Description |
 | :-------- | :---------- |
-| `BuildMark_VersionTagParsing` | Verifies parsing and comparing version tags from Git repositories |
-| `BuildMark_BuildInformationExtraction` | Verifies extracting build information from Git history |
 | `BuildMark_MarkdownReportGeneration` | Verifies generating markdown build notes reports |
-| `BuildMark_GitHubRepositoryConnector` | Verifies integration with GitHub API for issue and PR retrieval |
-| `BuildMark_MockRepositoryConnector` | Verifies mock repository connector for testing |
+| `BuildMark_GitIntegration` | Verifies git integration for version and commit information |
+| `BuildMark_IssueTracking` | Verifies issue tracking for changes and bugs |
+| `BuildMark_KnownIssuesReporting` | Verifies known issues reporting functionality |
 
 These tests provide evidence of the tool's functionality and are particularly useful for:
 
@@ -374,16 +373,23 @@ Example output:
 BuildMark version 1.0.0
 Copyright (c) DEMA Consulting
 
-# BuildMark Self-Validation Tests
+# DEMA Consulting BuildMark Self-validation
 
-[PASS] Version Tag Parsing
-[PASS] Build Information Extraction
-[PASS] Markdown Report Generation
-[PASS] GitHub Repository Connector
-[PASS] Mock Repository Connector
+| Information         | Value                                              |
+| :------------------ | :------------------------------------------------- |
+| BuildMark Version   | 1.0.0                                              |
+| Machine Name        | my-machine                                         |
+| OS Version          | Ubuntu 24.04.3 LTS                                 |
+| DotNet Runtime      | .NET 10.0.3                                        |
+| Time Stamp          | 2026-01-15 10:30:00 UTC                              |
 
-Total Tests: 5
-Passed: 5
+✓ Markdown Report Generation Test - PASSED
+✓ Git Integration Test - PASSED
+✓ Issue Tracking Test - PASSED
+✓ Known Issues Reporting Test - PASSED
+
+Total Tests: 4
+Passed: 4
 Failed: 0
 ```
 

src/DemaConsulting.BuildMark/RepoConnectors/GitHubRepoConnector.cs

@@ -393,7 +393,7 @@ private static (Version? fromVersion, string? fromHash) DetermineBaselineVersion
     private static Version? DetermineBaselineForPreRelease(int toIndex, string toHash, LookupData lookupData)
     {
         var releaseVersions = lookupData.ReleaseVersions;
-        
+
         // Determine starting index for search
         int startIndex;
         if (toIndex >= 0 && toIndex < releaseVersions.Count - 1)
@@ -422,7 +422,7 @@ private static (Version? fromVersion, string? fromHash) DetermineBaselineVersion
         for (var i = startIndex; i < releaseVersions.Count; i++)
         {
             var candidateVersion = releaseVersions[i];
-            
+
             // Get commit hash for candidate version
             if (lookupData.TagToRelease.TryGetValue(candidateVersion.Tag, out var candidateRelease) &&
                 lookupData.TagsByName.TryGetValue(candidateRelease.TagName!, out var candidateTag) &&

test/DemaConsulting.BuildMark.Tests/GitHubRepoConnectorTests.cs

@@ -128,7 +128,7 @@ public async Task GitHubRepoConnector_GetBuildInformationAsync_WithMultipleVersi
         Assert.IsNotNull(buildInfo);
         Assert.AreEqual("2.0.0", buildInfo.CurrentVersionTag.VersionInfo.FullVersion);
         Assert.AreEqual("commit3", buildInfo.CurrentVersionTag.CommitHash);
-        
+
         // Should have selected v1.1.0 as baseline (previous non-prerelease)
         Assert.IsNotNull(buildInfo.BaselineVersionTag);
         Assert.AreEqual("1.1.0", buildInfo.BaselineVersionTag.VersionInfo.FullVersion);
@@ -254,12 +254,12 @@ public async Task GitHubRepoConnector_GetBuildInformationAsync_WithOpenIssues_Id
 
         // Assert
         Assert.IsNotNull(buildInfo);
-        
+
         // Known issues are open issues that aren't linked to any changes in this release
         Assert.IsNotNull(buildInfo.KnownIssues);
         // Since we have no PRs, all open issues should be known issues
         Assert.IsGreaterThanOrEqualTo(1, buildInfo.KnownIssues.Count, $"Expected at least 1 known issue, got {buildInfo.KnownIssues.Count}");
-        
+
         // Verify at least one known issue is present
         var knownIssueTitles = buildInfo.KnownIssues.Select(i => i.Title).ToList();
         var hasExpectedIssue = knownIssueTitles.Exists(t => t.Contains("Known bug") || t.Contains("Feature request"));
@@ -306,7 +306,7 @@ public async Task GitHubRepoConnector_GetBuildInformationAsync_PreReleaseWithSam
         Assert.IsNotNull(buildInfo);
         Assert.AreEqual("1.1.2-rc.1", buildInfo.CurrentVersionTag.VersionInfo.FullVersion);
         Assert.AreEqual("a1b2c3d4", buildInfo.CurrentVersionTag.CommitHash);
-        
+
         // Should have skipped 1.1.2-beta.2 (same hash) and selected 1.1.2-beta.1 (different hash)
         Assert.IsNotNull(buildInfo.BaselineVersionTag);
         Assert.AreEqual("1.1.2-beta.1", buildInfo.BaselineVersionTag.VersionInfo.FullVersion);
@@ -358,7 +358,7 @@ public async Task GitHubRepoConnector_GetBuildInformationAsync_ReleaseVersion_Sk
         Assert.IsNotNull(buildInfo);
         Assert.AreEqual("1.1.2", buildInfo.CurrentVersionTag.VersionInfo.FullVersion);
         Assert.AreEqual("commit5", buildInfo.CurrentVersionTag.CommitHash);
-        
+
         // Should have skipped all pre-releases and selected 1.1.1
         Assert.IsNotNull(buildInfo.BaselineVersionTag);
         Assert.AreEqual("1.1.1", buildInfo.BaselineVersionTag.VersionInfo.FullVersion);
@@ -404,7 +404,7 @@ public async Task GitHubRepoConnector_GetBuildInformationAsync_PreReleaseNotInHi
         Assert.IsNotNull(buildInfo);
         Assert.AreEqual("1.1.2-beta.2", buildInfo.CurrentVersionTag.VersionInfo.FullVersion);
         Assert.AreEqual("new-hash-123", buildInfo.CurrentVersionTag.CommitHash);
-        
+
         // Should use most recent release with different hash
         Assert.IsNotNull(buildInfo.BaselineVersionTag);
         Assert.AreEqual("1.1.2-beta.1", buildInfo.BaselineVersionTag.VersionInfo.FullVersion);
@@ -448,7 +448,7 @@ public async Task GitHubRepoConnector_GetBuildInformationAsync_PreReleaseAllPrev
         Assert.IsNotNull(buildInfo);
         Assert.AreEqual("1.1.2-rc.1", buildInfo.CurrentVersionTag.VersionInfo.FullVersion);
         Assert.AreEqual("same-hash-123", buildInfo.CurrentVersionTag.CommitHash);
-        
+
         // Should have null baseline since all previous versions are on the same hash
         Assert.IsNull(buildInfo.BaselineVersionTag);
     }

test/DemaConsulting.BuildMark.Tests/MockRepoConnectorTests.cs

@@ -148,7 +148,7 @@ public async Task MockRepoConnector_GetBuildInformationAsync_CategorizesChangesC
         // - Issue #3 is documentation (type "documentation")
         var allItems = buildInfo.Changes.Concat(buildInfo.Bugs).ToList();
         Assert.IsGreaterThan(0, allItems.Count, "Should have at least one change");
-        
+
         // Verify bugs only contain items with type "bug"
         foreach (var bug in buildInfo.Bugs)
         {

test/DemaConsulting.BuildMark.Tests/ProcessRunnerTests.cs

@@ -48,7 +48,7 @@ public async Task ProcessRunner_TryRunAsync_WithValidCommand_ReturnsOutput()
 
         // Assert - Verify output is returned and contains expected text
         Assert.IsNotNull(result, "TryRunAsync should return output for successful command");
-        Assert.IsTrue(result.Contains("test", StringComparison.OrdinalIgnoreCase), 
+        Assert.IsTrue(result.Contains("test", StringComparison.OrdinalIgnoreCase),
             "Output should contain the echoed text");
     }
 

test/DemaConsulting.BuildMark.Tests/RepoConnectors/GitHub/GitHubGraphQLClientGetAllIssuesTests.cs

@@ -84,7 +84,7 @@ public async Task GitHubGraphQLClient_GetAllIssuesAsync_ValidResponse_ReturnsIss
         // Assert
         Assert.IsNotNull(issues);
         Assert.HasCount(2, issues);
-        
+
         Assert.AreEqual(1, issues[0].Number);
         Assert.AreEqual("Bug: Application crashes on startup", issues[0].Title);
         Assert.AreEqual("https://github.com/owner/repo/issues/1", issues[0].Url);