feat: Retry Upload Step (#1030)

Co-authored-by: Fabian-Lars <github@fabianlars.de>

Author: Prithvi Shivaraman

.changes/retry-upload.md

@@ -0,0 +1,5 @@
+---
+action: patch
+---
+
+`retryAttempts` is now also applied to uploads.

action.yml

@@ -51,7 +51,7 @@ inputs:
   args:
     description: 'Arguments for the `tauri build` command'
   retryAttempts:
-    description: 'The number of times to re-try building the app if the initial build fails. For now this only affects `tauri build` but may include the upload steps in the future.'
+    description: 'The number of times to re-try building the app if the initial build fails or uploading assets if the upload fails.'
   bundleIdentifier:
     description: 'The bundle identifier to inject when initializing the Tauri app'
   owner:

dist/index.js

@@ -186,23 +186,29 @@ async function run(): Promise<void> {
     }
 
     if (releaseId) {
-      await uploadReleaseAssets(owner, repo, releaseId, artifacts);
+      await uploadReleaseAssets(
+        owner,
+        repo,
+        releaseId,
+        artifacts,
+        retryAttempts,
+      );
 
       if (includeUpdaterJson) {
-        await uploadVersionJSON({
+        await uploadVersionJSON(
           owner,
           repo,
-          version: info.version,
-          notes: body,
+          info.version,
+          body,
           tagName,
           releaseId,
-          artifacts:
-            releaseArtifacts.length !== 0 ? releaseArtifacts : debugArtifacts,
+          releaseArtifacts.length !== 0 ? releaseArtifacts : debugArtifacts,
           targetInfo,
-          unzippedSig: info.unzippedSigs,
+          info.unzippedSigs,
           updaterJsonPreferNsis,
           updaterJsonKeepUniversal,
-        });
+          retryAttempts,
+        );
       }
     } else {
       console.log('No releaseId or tagName provided, skipping all uploads...');

src/index.ts

@@ -2,14 +2,15 @@ import fs from 'node:fs';
 
 import { getOctokit } from '@actions/github';
 
-import { getAssetName } from './utils';
+import { getAssetName, retry } from './utils';
 import type { Artifact } from './types';
 
 export async function uploadAssets(
   owner: string,
   repo: string,
   releaseId: number,
   assets: Artifact[],
+  retryAttempts: number,
 ) {
   if (process.env.GITHUB_TOKEN === undefined) {
     throw new Error('GITHUB_TOKEN is required');
@@ -58,15 +59,19 @@ export async function uploadAssets(
 
     console.log(`Uploading ${assetName}...`);
 
-    await github.rest.repos.uploadReleaseAsset({
-      headers,
-      name: assetName,
-      // https://github.com/tauri-apps/tauri-action/pull/45
-      // @ts-expect-error error TS2322: Type 'Buffer' is not assignable to type 'string'.
-      data: fs.createReadStream(asset.path),
-      owner: owner,
-      repo: repo,
-      release_id: releaseId,
-    });
+    return retry(
+      () =>
+        github.rest.repos.uploadReleaseAsset({
+          headers,
+          name: assetName,
+          // https://github.com/tauri-apps/tauri-action/pull/45
+          // @ts-expect-error error TS2322: Type 'Buffer' is not assignable to type 'string'.
+          data: fs.createReadStream(asset.path),
+          owner: owner,
+          repo: repo,
+          release_id: releaseId,
+        }),
+      retryAttempts + 1,
+    );
   }
 }

src/upload-release-assets.ts

@@ -22,31 +22,20 @@ type VersionContent = {
   };
 };
 
-export async function uploadVersionJSON({
-  owner,
-  repo,
-  version,
-  notes,
-  tagName,
-  releaseId,
-  artifacts,
-  targetInfo,
-  unzippedSig,
-  updaterJsonPreferNsis,
-  updaterJsonKeepUniversal,
-}: {
-  owner: string;
-  repo: string;
-  version: string;
-  notes: string;
-  tagName: string;
-  releaseId: number;
-  artifacts: Artifact[];
-  targetInfo: TargetInfo;
-  unzippedSig: boolean;
-  updaterJsonPreferNsis: boolean;
-  updaterJsonKeepUniversal: boolean;
-}) {
+export async function uploadVersionJSON(
+  owner: string,
+  repo: string,
+  version: string,
+  notes: string,
+  tagName: string,
+  releaseId: number,
+  artifacts: Artifact[],
+  targetInfo: TargetInfo,
+  unzippedSig: boolean,
+  updaterJsonPreferNsis: boolean,
+  updaterJsonKeepUniversal: boolean,
+  retryAttempts: number,
+) {
   if (process.env.GITHUB_TOKEN === undefined) {
     throw new Error('GITHUB_TOKEN is required');
   }
@@ -215,5 +204,11 @@ export async function uploadVersionJSON({
     });
   }
 
-  await uploadAssets(owner, repo, releaseId, [{ path: versionFile, arch: '' }]);
+  await uploadAssets(
+    owner,
+    repo,
+    releaseId,
+    [{ path: versionFile, arch: '' }],
+    retryAttempts,
+  );
 }