Improve update messaging & add release-drafter workflow

sellakumaran · sellakumaran · commit f7211dd5dc66 · 2026-01-21T14:29:40.000-08:00
- Enhance update notification in Program.cs for clarity, conciseness, and changelog link
- Dynamically generate update command with --prerelease flag for preview versions in VersionCheckService
- Refine version parsing to handle multiple preview formats
- Add and configure release-drafter.yml for automated GitHub release notes and draft releases, including workflow triggers and label-based categorization
- Improve code comments and documentation for maintainability
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -0,0 +1,69 @@
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+prerelease: true
+
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'bug'
+      - 'fix'
+  - title: '🔧 Maintenance'
+    labels:
+      - 'chore'
+      - 'dependencies'
+      - 'refactor'
+  - title: '📚 Documentation'
+    labels:
+      - 'documentation'
+      - 'docs'
+  - title: '⚡ Performance'
+    labels:
+      - 'performance'
+      - 'perf'
+
+change-template: '- $TITLE (#$NUMBER)'
+change-title-escapes: '\<*_&'
+
+version-resolver:
+  minor:
+    labels:
+      - 'feature'
+      - 'enhancement'
+  patch:
+    labels:
+      - 'bug'
+      - 'fix'
+      - 'chore'
+      - 'dependencies'
+      - 'documentation'
+      - 'performance'
+  default: patch
+
+autolabeler:
+  - label: 'documentation'
+    files:
+      - '*.md'
+      - 'docs/**/*'
+  - label: 'bug'
+    branch:
+      - '/fix\/.+/'
+    title:
+      - '/fix/i'
+      - '/bug/i'
+  - label: 'feature'
+    branch:
+      - '/feature\/.+/'
+    title:
+      - '/feat/i'
+      - '/feature/i'
+
+template: |
+  ## What's Changed
+
+  $CHANGES
+
+  **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -0,0 +1,20 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, reopened, synchronize, closed]
+
+permissions:
+  contents: write
+  pull-requests: read
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/src/Microsoft.Agents.A365.DevTools.Cli/Program.cs b/src/Microsoft.Agents.A365.DevTools.Cli/Program.cs
@@ -58,10 +58,11 @@ static async Task<int> Main(string[] args)
                 if (result.UpdateAvailable)
                 {
                     startupLogger.LogWarning("");
-                    startupLogger.LogWarning("A newer version of the Agent365 CLI is available!");
-                    startupLogger.LogWarning("Current version: {Current}", result.CurrentVersion);
-                    startupLogger.LogWarning("Latest version:  {Latest}", result.LatestVersion);
+                    startupLogger.LogWarning("A newer version is available with bug fixes and improvements.");
+                    startupLogger.LogWarning("  Current: {Current}", result.CurrentVersion);
+                    startupLogger.LogWarning("  Latest:  {Latest}", result.LatestVersion);
                     startupLogger.LogWarning("");
+                    startupLogger.LogWarning("What's new: https://github.com/microsoft/Agent365-devTools/releases");
                     startupLogger.LogWarning("To update, run: {Command}", result.UpdateCommand);
                     startupLogger.LogWarning("");
                 }
diff --git a/src/Microsoft.Agents.A365.DevTools.Cli/Services/VersionCheckService.cs b/src/Microsoft.Agents.A365.DevTools.Cli/Services/VersionCheckService.cs
@@ -15,7 +15,6 @@ public class VersionCheckService : IVersionCheckService
 {
     private const string NuGetApiUrl = "https://api.nuget.org/v3-flatcontainer/microsoft.agents.a365.devtools.cli/index.json";
     private const string PackageId = "Microsoft.Agents.A365.DevTools.Cli";
-    private const string UpdateCommand = "dotnet tool update -g Microsoft.Agents.A365.DevTools.Cli";
 
     private readonly ILogger<VersionCheckService> _logger;
     private readonly string _currentVersion;
@@ -61,7 +60,10 @@ public async Task<VersionCheckResult> CheckForUpdatesAsync(CancellationToken can
                 _logger.LogDebug("Running latest version: {CurrentVersion}", _currentVersion);
             }
 
-            return new VersionCheckResult(updateAvailable, _currentVersion, latestVersion, UpdateCommand);
+            // Generate update command based on whether the latest version is a preview
+            var updateCommand = GetUpdateCommand(latestVersion);
+
+            return new VersionCheckResult(updateAvailable, _currentVersion, latestVersion, updateCommand);
         }
         catch (OperationCanceledException)
         {
@@ -176,35 +178,54 @@ internal Version ParseVersion(string versionString)
     /// <summary>
     /// Tries to parse a semantic version string into a comparable Version object.
     /// Returns null if parsing fails.
-    /// 
+    ///
     /// Note: This parsing treats preview versions as comparable by their preview number.
-    /// For example, "1.1.0-preview.50" becomes "1.1.0.50" for comparison purposes.
-    /// This is appropriate since we're comparing preview-to-preview versions (the package is in preview).
+    /// Handles two formats:
+    /// - "1.1.52-preview" (version number includes preview iteration)
+    /// - "1.1.0-preview.50" (preview number is separate)
     /// </summary>
     private Version? TryParseVersion(string versionString)
     {
         try
         {
-            // Remove any build metadata (+...) and pre-release tags (-...)
-            var cleanVersion = versionString.Split('+')[0]; // Remove build metadata
+            // Remove any build metadata (+...)
+            var cleanVersion = versionString.Split('+')[0];
 
-            // For preview versions, extract just the base version number
+            // For preview versions, extract the version number
             if (cleanVersion.Contains('-'))
             {
                 var parts = cleanVersion.Split('-');
-                // Use the numeric part before the dash as base version
-                cleanVersion = parts[0];
+                var baseVersion = parts[0]; // e.g., "1.1.52" or "1.1.0"
 
-                // If there's a preview number, append it as the fourth component
-                if (parts.Length > 1 && parts[1].StartsWith("preview."))
+                // Check if there's a preview number after the dash
+                if (parts.Length > 1)
                 {
-                    var previewNumber = parts[1].Replace("preview.", "");
-                    if (int.TryParse(previewNumber, out var preview))
+                    var previewPart = parts[1]; // e.g., "preview" or "preview.50"
+
+                    // Format 1: "1.1.0-preview.50" - append preview number as revision
+                    if (previewPart.StartsWith("preview.") && previewPart.Length > 8)
+                    {
+                        var previewNumber = previewPart.Substring(8); // Get number after "preview."
+                        if (int.TryParse(previewNumber, out var preview))
+                        {
+                            cleanVersion = $"{baseVersion}.{preview}";
+                        }
+                        else
+                        {
+                            // If parsing fails, just use base version
+                            cleanVersion = baseVersion;
+                        }
+                    }
+                    // Format 2: "1.1.52-preview" - version already includes iteration number
+                    else
                     {
-                        // Append preview number as revision component
-                        cleanVersion = $"{cleanVersion}.{preview}";
+                        cleanVersion = baseVersion;
                     }
                 }
+                else
+                {
+                    cleanVersion = baseVersion;
+                }
             }
 
             // Ensure we have at least 3 components for Version constructor
@@ -223,6 +244,24 @@ internal Version ParseVersion(string versionString)
         }
     }
 
+    /// <summary>
+    /// Generates the appropriate update command based on the version type.
+    /// </summary>
+    /// <param name="version">The version string to check for preview status.</param>
+    /// <returns>The dotnet tool update command with or without --prerelease flag.</returns>
+    private static string GetUpdateCommand(string version)
+    {
+        var baseCommand = $"dotnet tool update -g {PackageId}";
+
+        // If the version contains "preview", add the --prerelease flag
+        if (version.Contains("preview", StringComparison.OrdinalIgnoreCase))
+        {
+            return $"{baseCommand} --prerelease";
+        }
+
+        return baseCommand;
+    }
+
     /// <summary>
     /// Detects if the CLI is running in a CI/CD environment.
     /// </summary>
