Fix: Updater fixes and improvements (#13)

plz12345 · web-flow · commit d8426ce5c038 · 2026-01-17T21:53:14.000-05:00
diff --git a/.github/workflows/build_v3.yml b/.github/workflows/build_v3.yml
@@ -17,7 +17,7 @@ on:
       - "src/Whisparr.Api.*/openapi.json"
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  group: ${{ github.workflow }}-pr-${{ github.event.pull_request.number }}
   cancel-in-progress: true
 
 env:
@@ -91,6 +91,8 @@ jobs:
     steps:
       - name: Check out
         uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
 
       - name: Build
         uses: ./.github/actions/build
@@ -106,6 +108,8 @@ jobs:
     steps:
       - name: Check out
         uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
 
       - name: Volta
         uses: volta-cli/action@v4
@@ -151,6 +155,8 @@ jobs:
     steps:
       - name: Check out
         uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
 
       - name: Test
         uses: ./.github/actions/test
@@ -170,6 +176,8 @@ jobs:
     steps:
       - name: Check out
         uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
 
       - name: Test
         uses: ./.github/actions/test
@@ -207,6 +215,8 @@ jobs:
     steps:
       - name: Check out
         uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
       - name: Test
         uses: ./.github/actions/test
         with:
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -69,6 +69,9 @@ jobs:
     steps:
       - name: Check out
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
 
       - name: Download release artifacts
         uses: actions/download-artifact@v4
@@ -84,23 +87,7 @@ jobs:
           GITHUB_TOKEN: ${{ github.token }}
         with:
           latest: true
-          prerelease: ${{ inputs.branch != 'main' }}
-
-      - name: Generate Release Notes
-        id: generate-release-notes
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ github.token }}
-          result-encoding: string
-          script: |
-            const { data } = await github.rest.repos.generateReleaseNotes({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              tag_name: 'v${{ inputs.version }}',
-              target_commitish: '${{ github.sha }}',
-              previous_tag_name: '${{ steps.previous-release.outputs.tag_name }}',
-            })
-            return data.body
+          prerelease: ${{ inputs.branch != 'eros' }}
 
       - name: Enable GPG signing
         uses: crazy-max/ghaction-import-gpg@v6
@@ -118,13 +105,22 @@ jobs:
         env:
           GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
 
+      - name: Generate Commit Changelog
+        id: generate-commit-changelog
+        run: |
+          PREV_TAG="${{ steps.previous-release.outputs.tag_name }}"
+          CUR_TAG="v${{ inputs.version }}"
+          echo "## What's Changed" > changelog.md
+          git log "$PREV_TAG..$CUR_TAG" --pretty=format:"- %s (%h) - @%an" >> changelog.md
+          cat changelog.md
+
       - name: Create release
         uses: ncipollo/release-action@v1
         with:
           artifacts: _artifacts/Whisparr.*
           commit: ${{ github.sha }}
           generateReleaseNotes: false
-          body: ${{ steps.generate-release-notes.outputs.result }}
+          bodyFile: changelog.md
           name: ${{ inputs.version }}
           prerelease: ${{ inputs.branch != 'eros' }}
           skipIfReleaseExists: true
diff --git a/frontend/src/System/Updates/Updates.css b/frontend/src/System/Updates/Updates.css
@@ -51,3 +51,7 @@
   margin-left: 10px;
   font-size: 14px;
 }
+
+a {
+  color: var(--linkColor);
+}
diff --git a/frontend/src/System/Updates/Updates.tsx b/frontend/src/System/Updates/Updates.tsx
@@ -269,7 +269,7 @@ function Updates() {
                     return (
                       <InlineMarkdown
                         data={translate('MaintenanceReleaseWithLink', {
-                          url: 'https://github.com/Whisparr/Whisparr/commits/eros/',
+                          url: 'https://github.com/Whisparr/Whisparr-Eros/commits/eros/',
                         })}
                       />
                     );
diff --git a/src/NzbDrone.Core.Test/HealthCheck/Checks/ReleaseBranchCheckFixture.cs b/src/NzbDrone.Core.Test/HealthCheck/Checks/ReleaseBranchCheckFixture.cs
@@ -35,10 +35,10 @@ public void should_return_warning_when_branch_is_not_valid(string branch)
             Subject.Check().ShouldBeWarning();
         }
 
-        [TestCase("nightly")]
-        [TestCase("Nightly")]
-        [TestCase("develop")]
-        [TestCase("master")]
+        [TestCase("eros")]
+        [TestCase("eros-develop")]
+        [TestCase("Eros")]
+        [TestCase("Eros-Develop")]
         public void should_return_no_warning_when_branch_valid(string branch)
         {
             GivenValidBranch(branch);
diff --git a/src/NzbDrone.Core/HealthCheck/Checks/ReleaseBranchCheck.cs b/src/NzbDrone.Core/HealthCheck/Checks/ReleaseBranchCheck.cs
@@ -19,7 +19,7 @@ public ReleaseBranchCheck(IConfigFileProvider configFileService, ILocalizationSe
 
         public override HealthCheck Check()
         {
-            var currentBranch = _configFileService.Branch.ToLower();
+            var currentBranch = _configFileService.Branch.ToLower().Replace("-", "");
 
             if (!Enum.GetNames(typeof(ReleaseBranches)).Any(x => x.ToLower() == currentBranch))
             {
@@ -31,10 +31,8 @@ public override HealthCheck Check()
 
         public enum ReleaseBranches
         {
-            Master,
-            Develop,
-            Nightly,
-            Eros
+            Eros,
+            ErosDevelop
         }
     }
 }
diff --git a/src/NzbDrone.Core/Update/GithubUpdatePackageProvider.cs b/src/NzbDrone.Core/Update/GithubUpdatePackageProvider.cs
@@ -3,13 +3,15 @@
 using System.Linq;
 using System.Runtime.InteropServices;
 using System.Text.Json;
+using System.Text.RegularExpressions;
 using NLog;
 using NzbDrone.Common.Cloud;
 using NzbDrone.Common.EnvironmentInfo;
 using NzbDrone.Common.Http;
 using NzbDrone.Core.Analytics;
 using NzbDrone.Core.Configuration;
 using NzbDrone.Core.Datastore;
+using Semver;
 
 namespace NzbDrone.Core.Update
 {
@@ -54,11 +56,15 @@ public UpdatePackage GetLatestUpdate(string branch, Version currentVersion)
             if (latest != null)
             {
                 _logger.Info("Update found: {0} ({1})", latest.Version, latest.FileName);
-                if (Semver.SemVersion.ComparePrecedence(Semver.SemVersion.Parse(currentVersion.ToString()), latest.Version) >= 0)
+
+                // Convert latest.Version (SemVersion) to .NET Version for comparison
+                var latestDotNetVersion = releaseVersionAsAssemblyVersion(latest.Version.ToString());
+
+                if (currentVersion >= latestDotNetVersion)
                 {
                     _logger.Info("Current version '{0}' is up-to-date or newer than the latest available update '{1}'.",
                         currentVersion,
-                        latest.Version);
+                        latestDotNetVersion);
                     return null;
                 }
 
@@ -88,7 +94,7 @@ public List<UpdatePackage> GetRecentUpdates(string branch, Version currentVersio
 
             var builder = _cloudRequestBuilder.GithubReleases.Create();
             builder.SetSegment("githubownerrepo", ownerRepo);
-            builder.AddQueryParam("per_page", "5");
+            builder.AddQueryParam("per_page", "25");
 
             var request = builder.Build();
             _logger.Debug($"Requesting: {request.Url}");
@@ -104,16 +110,58 @@ public List<UpdatePackage> GetRecentUpdates(string branch, Version currentVersio
             var packages = new List<UpdatePackage>();
             foreach (var release in releases)
             {
+                // Filter out releases that do not match the requested branch
+                // For example, if branch is 'eros-develop', skip tags like 'v3.2.0-release.27'
+                // You may need to adjust this logic if your tag naming changes
+                if (!string.IsNullOrEmpty(branch))
+                {
+                    var tagLower = release.tag_name.ToLowerInvariant();
+                    var branchLower = branch.ToLowerInvariant();
+
+                    // If branch is exactly 'eros', skip prerelease tags
+                    if (branchLower == "eros" && tagLower.Contains("develop"))
+                    {
+                        _logger.Debug($"Skipping prerelease {release.tag_name} for stable branch {branch}.");
+                        continue;
+                    }
+
+                    // If branch contains 'develop', skip tags with 'release' and vice versa
+                    if (branchLower.Contains("develop") && !tagLower.Contains("develop"))
+                    {
+                        _logger.Debug($"Skipping release {release.tag_name} because it is a release tag and branch is {branch}.");
+                        continue;
+                    }
+                }
+
                 if (release.assets == null)
                 {
                     _logger.Debug($"Release {release.tag_name} has no package assets, skipping.");
                     continue;
                 }
 
-                // Filter release assets by mapped OS asset string and architecture
-                var asset = release.assets.FirstOrDefault(a =>
-                    a.name.Contains(osAssetString, StringComparison.OrdinalIgnoreCase) &&
-                    a.name.Contains(arch, StringComparison.OrdinalIgnoreCase));
+                // Prefer .tar.gz for Osx, fallback to .zip/.app
+                GithubAsset asset = null;
+                if (OsInfo.Os == Os.Osx)
+                {
+                    asset = release.assets.FirstOrDefault(a =>
+                        a.name.Contains(osAssetString, StringComparison.OrdinalIgnoreCase) &&
+                        a.name.Contains(arch, StringComparison.OrdinalIgnoreCase) &&
+                        a.name.EndsWith(".tar.gz", StringComparison.OrdinalIgnoreCase));
+                    if (asset == null)
+                    {
+                        asset = release.assets.FirstOrDefault(a =>
+                            a.name.Contains(osAssetString, StringComparison.OrdinalIgnoreCase) &&
+                            a.name.Contains(arch, StringComparison.OrdinalIgnoreCase) &&
+                            (a.name.EndsWith(".zip", StringComparison.OrdinalIgnoreCase) || a.name.EndsWith(".app", StringComparison.OrdinalIgnoreCase)));
+                    }
+                }
+                else
+                {
+                    asset = release.assets.FirstOrDefault(a =>
+                        a.name.Contains(osAssetString, StringComparison.OrdinalIgnoreCase) &&
+                        a.name.Contains(arch, StringComparison.OrdinalIgnoreCase));
+                }
+
                 if (asset == null)
                 {
                     _logger.Debug("No asset found for release {0} matching OS asset string '{1}' and arch '{2}'",
@@ -125,7 +173,12 @@ public List<UpdatePackage> GetRecentUpdates(string branch, Version currentVersio
 
                 _logger.Debug($"Found update: {release.tag_name} - {asset.name}");
                 var tag = release.tag_name.TrimStart('v');
-                var version = Semver.SemVersion.Parse(tag);
+
+                // Attempt to strip "what's new", as it's repetitive in our UI
+                var body = release?.body != null
+                    ? Regex.Replace(release.body, @"^## What's Changed\s*\r?\n", "", RegexOptions.Multiline)
+                    : string.Empty;
+                var version = SemVersion.Parse(tag);
                 if (version == null)
                 {
                     _logger.Warn("Could not parse semver from tag '{0}' (parsed: '{1}'). Skipping this release.",
@@ -141,8 +194,8 @@ public List<UpdatePackage> GetRecentUpdates(string branch, Version currentVersio
                     ReleaseDate = release.published_at,
                     FileName = asset.name,
                     Url = asset.browser_download_url,
-                    Changes = new UpdateChanges { New = new List<string> { release.body } },
-                    Hash = asset.digest,
+                    Changes = new UpdateChanges { New = new List<string> { body } },
+                    Hash = asset.digest.Replace("sha256:", "", StringComparison.OrdinalIgnoreCase),
                     Branch = branch
                 });
             }
@@ -151,6 +204,37 @@ public List<UpdatePackage> GetRecentUpdates(string branch, Version currentVersio
             return packages;
         }
 
+        /// <summary> Converts a GitHub release version string to a .NET Version object.</summary>
+        /// <param name="releaseTag">The release version string (e.g., "v3.2.0-develop.23").</param>
+        /// <returns>The corresponding .NET Assembly Version object.(e.e., 3.2.0.27)</returns>
+        private static Version releaseVersionAsAssemblyVersion(string releaseTag)
+        {
+            var semver = SemVersion.Parse(releaseTag.TrimStart('v'));
+            if (semver == null)
+            {
+                throw new ArgumentException($"Invalid semver: {releaseTag}", nameof(releaseTag));
+            }
+
+            // Use major, minor, patch, and if available, the last numeric part of prerelease as revision
+            var major = (int)semver.Major;
+            var minor = (int)semver.Minor;
+            var build = (int)semver.Patch;
+
+            // Try to extract revision from prerelease (e.g., 3.2.0-develop.23)
+            var revision = 0;
+
+            if (!string.IsNullOrEmpty(semver.Prerelease))
+            {
+                var parts = semver.Prerelease.Split('.');
+                if (parts.Length > 0 && int.TryParse(parts.Last(), out var rev))
+                {
+                    revision = rev;
+                }
+            }
+
+            return new Version(major, minor, build, revision);
+        }
+
         /// <summary>
         /// Maps the OsInfo.Os enum to the asset string prefix used in GitHub release asset names.
         /// </summary>
@@ -175,7 +259,7 @@ private static string GetOsAssetString(Os os)
             }
         }
 
-        private class GithubRelease
+        internal class GithubRelease
         {
             /// <summary>The tag name of the release.</summary>
             public string tag_name { get; set; }
@@ -191,12 +275,12 @@ private class GithubRelease
         }
 
         /// <summary>Represents an asset in a GitHub release.</summary>
-        private class GithubAsset
+        internal class GithubAsset
         {
             /// <summary>The name of the asset file.</summary>
             public string name { get; set; }
 
-            /// <summary>The digest (sha:hash) of the asset.</summary>
+            /// <summary>The digest (sha256 hash) of the asset.</summary>
             public string digest { get; set; }
 
             /// <summary>The download URL of the asset.</summary>
diff --git a/src/NzbDrone.Core/Update/InstallUpdateService.cs b/src/NzbDrone.Core/Update/InstallUpdateService.cs
@@ -139,6 +139,31 @@ private bool InstallUpdate(UpdatePackage updatePackage)
             _archiveService.Extract(packageDestination, updateSandboxFolder);
             _logger.Info("Update package extracted successfully");
 
+            // Log the contents of the updateSandboxFolder after extraction
+
+            try
+            {
+                var extractedDirs = _diskProvider.GetDirectories(updateSandboxFolder);
+                var extractedFiles = _diskProvider.GetFiles(updateSandboxFolder, true); // true = recursive
+                _logger.Info("[Update Debug] Contents of updateSandboxFolder after extraction:");
+                foreach (var dir in extractedDirs)
+                {
+                    _logger.Info("[Update Debug] Dir: {0}", dir);
+                }
+
+                foreach (var file in extractedFiles)
+                {
+                    _logger.Info("[Update Debug] File: {0}", file);
+                }
+            }
+            catch (Exception ex)
+            {
+                _logger.Warn(ex, "[Update Debug] Failed to enumerate extracted updateSandboxFolder contents");
+            }
+
+            var expectedUpdateClientFolder = _appFolderInfo.GetUpdateClientFolder();
+            _logger.Info("[Update Debug] Expected update client folder: {0}", expectedUpdateClientFolder);
+
             EnsureValidBranch(updatePackage);
 
             _backupService.Backup(BackupType.Update);

Original file line number	Diff line number	Diff line change
`@@ -51,3 +51,7 @@`
`51`	`51`	`margin-left: 10px;`
`52`	`52`	`font-size: 14px;`
`53`	`53`	`}`
	`54`	`+`
	`55`	`+a {`
	`56`	`+ color: var(--linkColor);`
	`57`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -35,10 +35,10 @@ public void should_return_warning_when_branch_is_not_valid(string branch)`
`35`	`35`	`Subject.Check().ShouldBeWarning();`
`36`	`36`	`}`
`37`	`37`
`38`		`- [TestCase("nightly")]`
`39`		`- [TestCase("Nightly")]`
`40`		`- [TestCase("develop")]`
`41`		`- [TestCase("master")]`
	`38`	`+ [TestCase("eros")]`
	`39`	`+ [TestCase("eros-develop")]`
	`40`	`+ [TestCase("Eros")]`
	`41`	`+ [TestCase("Eros-Develop")]`
`42`	`42`	`public void should_return_no_warning_when_branch_valid(string branch)`
`43`	`43`	`{`
`44`	`44`	`GivenValidBranch(branch);`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public ReleaseBranchCheck(IConfigFileProvider configFileService, ILocalizationSe`
`19`	`19`
`20`	`20`	`public override HealthCheck Check()`
`21`	`21`	`{`
`22`		`- var currentBranch = _configFileService.Branch.ToLower();`
	`22`	`+ var currentBranch = _configFileService.Branch.ToLower().Replace("-", "");`
`23`	`23`
`24`	`24`	`if (!Enum.GetNames(typeof(ReleaseBranches)).Any(x => x.ToLower() == currentBranch))`
`25`	`25`	`{`
`@@ -31,10 +31,8 @@ public override HealthCheck Check()`
`31`	`31`
`32`	`32`	`public enum ReleaseBranches`
`33`	`33`	`{`
`34`		`- Master,`
`35`		`- Develop,`
`36`		`- Nightly,`
`37`		`- Eros`
	`34`	`+ Eros,`
	`35`	`+ ErosDevelop`
`38`	`36`	`}`
`39`	`37`	`}`
`40`	`38`	`}`