Merge pull request #148 from xavier2k6/nf_retry_p1

Bump `ci_cd` workflow actions

.github/workflows/ci_cd.yml

@@ -14,16 +14,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
       - name: Run Unit Tests
         run: npm test
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v5
         with:
           directory: ./coverage/
           verbose: true
@@ -33,11 +33,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
 
@@ -48,7 +48,7 @@ jobs:
           timeout_minutes: 1
           max_attempts: 2
           command: npm -v
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: true
           actual: ${{ steps.happy_path.outputs.total_attempts == '1' && steps.happy_path.outputs.exit_code == '0' }}
@@ -67,11 +67,11 @@ jobs:
           timeout_minutes: 1
           max_attempts: 2
           command: node -e "process.exit(1)"
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 2
           actual: ${{ steps.sad_path_error.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: failure
           actual: ${{ steps.sad_path_error.outcome }}
@@ -85,15 +85,15 @@ jobs:
           max_attempts: 3
           retry_on: timeout
           command: node -e "process.exit(2)"
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 1
           actual: ${{ steps.retry_on_timeout_fail.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: failure
           actual: ${{ steps.retry_on_timeout_fail.outcome }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 2
           actual: ${{ steps.retry_on_timeout_fail.outputs.exit_code }}
@@ -107,15 +107,15 @@ jobs:
           max_attempts: 2
           retry_on: error
           command: node -e "process.exit(2)"
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 2
           actual: ${{ steps.retry_on_error.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: failure
           actual: ${{ steps.retry_on_error.outcome }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 2
           actual: ${{ steps.retry_on_error.outputs.exit_code }}
@@ -129,11 +129,11 @@ jobs:
           max_attempts: 2
           shell: cmd
           command: 'dir'
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 2
           actual: ${{ steps.wrong_shell.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: failure
           actual: ${{ steps.wrong_shell.outcome }}
@@ -143,11 +143,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
       - name: env-vars-passed-through
@@ -164,11 +164,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
       - name: Test 100MiB of output can be processed
@@ -180,12 +180,12 @@ jobs:
           timeout_minutes: 5
           command: 'make -C ./test-data/large-output bytes-102400'
       - name: Assert test had expected result
-        uses: nick-invision/assert-action@v1
+        uses: nick-fields/assert-action@v2
         with:
           expected: failure
           actual: ${{ steps.large-output.outcome }}
       - name: Assert exit code is expected
-        uses: nick-invision/assert-action@v1
+        uses: nick-fields/assert-action@v2
         with:
           expected: 2
           actual: ${{ steps.large-output.outputs.exit_code }}
@@ -195,11 +195,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
       - name: retry_on_exit_code (with expected error code)
@@ -211,11 +211,11 @@ jobs:
           retry_on_exit_code: 2
           max_attempts: 3
           command: node -e "process.exit(2)"
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: failure
           actual: ${{ steps.retry_on_exit_code_expected.outcome }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 3
           actual: ${{ steps.retry_on_exit_code_expected.outputs.total_attempts }}
@@ -229,11 +229,11 @@ jobs:
           retry_on_exit_code: 2
           max_attempts: 3
           command: node -e "process.exit(1)"
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: failure
           actual: ${{ steps.retry_on_exit_code_unexpected.outcome }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 1
           actual: ${{ steps.retry_on_exit_code_unexpected.outputs.total_attempts }}
@@ -243,11 +243,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
       - name: happy-path (continue_on_error)
@@ -265,22 +265,22 @@ jobs:
           timeout_minutes: 1
           continue_on_error: true
       - name: Verify continue_on_error returns correct exit code on success
-        uses: nick-invision/assert-action@v1
+        uses: nick-fields/assert-action@v2
         with:
           expected: 0
           actual: ${{ steps.happy_path_continue_on_error.outputs.exit_code }}
       - name: Verify continue_on_error exits with correct outcome on success
-        uses: nick-invision/assert-action@v1
+        uses: nick-fields/assert-action@v2
         with:
           expected: success
           actual: ${{ steps.happy_path_continue_on_error.outcome }}
       - name: Verify continue_on_error returns correct exit code on error
-        uses: nick-invision/assert-action@v1
+        uses: nick-fields/assert-action@v2
         with:
           expected: 33
           actual: ${{ steps.sad_path_continue_on_error.outputs.exit_code }}
       - name: Verify continue_on_error exits with successful outcome when an error occurs
-        uses: nick-invision/assert-action@v1
+        uses: nick-fields/assert-action@v2
         with:
           expected: success
           actual: ${{ steps.sad_path_continue_on_error.outcome }}
@@ -290,11 +290,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
 
@@ -307,15 +307,15 @@ jobs:
           max_attempts: 3
           retry_wait_seconds: 15
           command: npm install this-isnt-a-real-package-name-zzz
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 3
           actual: ${{ steps.sad_path_wait_sec.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: failure
           actual: ${{ steps.sad_path_wait_sec.outcome }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 'Final attempt failed'
           actual: ${{ steps.sad_path_wait_sec.outputs.exit_error }}
@@ -326,11 +326,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
 
@@ -369,11 +369,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
 
@@ -385,11 +385,11 @@ jobs:
           timeout_seconds: 15
           max_attempts: 2
           command: node -e "(async()=>await new Promise(r => setTimeout(r, 120000)))()"
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 2
           actual: ${{ steps.sad_path_timeout.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: failure
           actual: ${{ steps.sad_path_timeout.outcome }}
@@ -399,11 +399,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
 
@@ -416,11 +416,11 @@ jobs:
           max_attempts: 2
           retry_on: timeout
           command: node -e "(async()=>await new Promise(r => setTimeout(r, 120000)))()"
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 2
           actual: ${{ steps.retry_on_timeout.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: failure
           actual: ${{ steps.retry_on_timeout.outcome }}
@@ -430,11 +430,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
 
@@ -447,15 +447,15 @@ jobs:
           max_attempts: 2
           retry_on: error
           command: node -e "(async()=>await new Promise(r => setTimeout(r, 120000)))()"
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 1
           actual: ${{ steps.retry_on_error_fail.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: failure
           actual: ${{ steps.retry_on_error_fail.outcome }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 1
           actual: ${{ steps.retry_on_error_fail.outputs.exit_code }}
@@ -465,11 +465,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
 
@@ -481,11 +481,11 @@ jobs:
           timeout_minutes: 1
           max_attempts: 2
           command: node -e "(async()=>await new Promise(r => setTimeout(r, 120000)))()"
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: 2
           actual: ${{ steps.sad_path_timeout_minutes.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
+      - uses: nick-fields/assert-action@v2
         with:
           expected: failure
           actual: ${{ steps.sad_path_timeout_minutes.outcome }}
@@ -495,11 +495,11 @@ jobs:
     runs-on: windows-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
       - name: Powershell test
@@ -571,11 +571,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: npm ci
       - name: Release
@@ -584,6 +584,8 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Tag
+        # only bump v# (e.g., v3) tag if semantic release action publishes any new version
+        if: ${{ steps.semantic.outputs.new_release_major_version != '' }}
         run: git tag -f v${MAJOR_VERSION} && git push -f origin v${MAJOR_VERSION}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.nvmrc

@@ -1 +1 @@
-v16.16.0
+v20.11.0

README.md

@@ -79,7 +79,7 @@ The final error returned by the command
 ### Shell
 
 ```yaml
-uses: nick-fields/retry@v2
+uses: nick-fields/retry@v3
 with:
   timeout_minutes: 10
   max_attempts: 3
@@ -90,7 +90,7 @@ with:
 ### Timeout in minutes
 
 ```yaml
-uses: nick-fields/retry@v2
+uses: nick-fields/retry@v3
 with:
   timeout_minutes: 10
   max_attempts: 3
@@ -100,7 +100,7 @@ with:
 ### Timeout in seconds
 
 ```yaml
-uses: nick-fields/retry@v2
+uses: nick-fields/retry@v3
 with:
   timeout_seconds: 15
   max_attempts: 3
@@ -110,7 +110,7 @@ with:
 ### Only retry after timeout
 
 ```yaml
-uses: nick-fields/retry@v2
+uses: nick-fields/retry@v3
 with:
   timeout_seconds: 15
   max_attempts: 3
@@ -121,7 +121,7 @@ with:
 ### Only retry after error
 
 ```yaml
-uses: nick-fields/retry@v2
+uses: nick-fields/retry@v3
 with:
   timeout_seconds: 15
   max_attempts: 3
@@ -132,7 +132,7 @@ with:
 ### Retry using continue_on_error input (in composite action) but allow failure and do something with output
 
 ```yaml
-- uses: nick-fields/retry@v2
+- uses: nick-fields/retry@v3
   id: retry
   with:
     timeout_seconds: 15
@@ -154,7 +154,7 @@ with:
 ### Retry using continue-on-error built-in command (in workflow action) but allow failure and do something with output
 
 ```yaml
-- uses: nick-fields/retry@v2
+- uses: nick-fields/retry@v3
   id: retry
   # see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idcontinue-on-error
   continue-on-error: true
@@ -183,7 +183,7 @@ with:
 ### Run script after failure but before retry
 
 ```yaml
-uses: nick-fields/retry@v2
+uses: nick-fields/retry@v3
 with:
   timeout_seconds: 15
   max_attempts: 3
@@ -194,7 +194,7 @@ with:
 ### Run different command after first failure
 
 ```yaml
-uses: nick-fields/retry@v2
+uses: nick-fields/retry@v3
 with:
   timeout_seconds: 15
   max_attempts: 3
@@ -206,7 +206,7 @@ with:
 
 ```yaml
 name: Multi-line multi-command Test
-uses: ./
+uses: nick-fields/retry@v3
 with:
   timeout_minutes: 1
   max_attempts: 2
@@ -219,7 +219,7 @@ with:
 
 ```yaml
 name: Multi-line single-command Test
-uses: ./
+uses: nick-fields/retry@v3
 with:
   timeout_minutes: 1
   max_attempts: 2

action.yml

@@ -50,5 +50,5 @@ outputs:
   exit_error:
     description: The final error returned by the command
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'

package.json

@@ -13,15 +13,15 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/nick-invision/retry.git"
+    "url": "git+https://github.com/nick-fields/retry.git"
   },
   "keywords": [],
   "author": "Nick Fields",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/nick-invision/retry/issues"
+    "url": "https://github.com/nick-fields/retry/issues"
   },
-  "homepage": "https://github.com/nick-invision/retry#readme",
+  "homepage": "https://github.com/nick-fields/retry#readme",
   "dependencies": {
     "@actions/core": "^1.10.0",
     "milliseconds": "^1.0.3",
@@ -30,14 +30,14 @@
   "devDependencies": {
     "@commitlint/cli": "^16.2.3",
     "@commitlint/config-conventional": "^16.2.1",
-    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@types/jest": "^28.1.6",
     "@types/milliseconds": "0.0.30",
     "@types/node": "^16.11.7",
     "@typescript-eslint/eslint-plugin": "^5.32.0",
     "@typescript-eslint/parser": "^5.32.0",
-    "@zeit/ncc": "^0.20.5",
+    "@vercel/ncc": "^0.38.1",
     "dotenv": "8.2.0",
     "eslint": "^8.21.0",
     "eslint-config-prettier": "^8.5.0",
@@ -45,7 +45,7 @@
     "jest": "^28.1.3",
     "lint-staged": "^13.0.3",
     "prettier": "^2.7.1",
-    "semantic-release": "19.0.3",
+    "semantic-release": "^24.2.3",
     "ts-jest": "^28.0.7",
     "ts-node": "9.0.0",
     "typescript": "^4.7.4",

src/index.ts

@@ -11,16 +11,9 @@ const OUTPUT_TOTAL_ATTEMPTS_KEY = 'total_attempts';
 const OUTPUT_EXIT_CODE_KEY = 'exit_code';
 const OUTPUT_EXIT_ERROR_KEY = 'exit_error';
 
+let exit: number;
 let done: boolean;
 
-class ErrorWithCode extends Error {
-  constructor(readonly message: string, readonly code: number) {
-    super();
-    this.code = code;
-    this.message = message;
-  }
-}
-
 function getExecutable(inputs: Inputs): string {
   if (!inputs.shell) {
     return OS === 'win32' ? 'powershell' : 'bash';
@@ -78,7 +71,7 @@ async function runCmd(attempt: number, inputs: Inputs) {
   const end_time = Date.now() + getTimeout(inputs);
   const executable = getExecutable(inputs);
 
-  let exit = 0;
+  exit = 0;
   done = false;
   let timeout = false;
 
@@ -124,10 +117,10 @@ async function runCmd(attempt: number, inputs: Inputs) {
     timeout = true;
     kill(child.pid);
     await retryWait(ms.seconds(inputs.retry_wait_seconds));
-    throw new ErrorWithCode(`Timeout of ${getTimeout(inputs)}ms hit`, exit);
+    throw new Error(`Timeout of ${getTimeout(inputs)}ms hit`);
   } else if (exit > 0) {
     await retryWait(ms.seconds(inputs.retry_wait_seconds));
-    throw new ErrorWithCode(`Child_process exited with error code ${exit}`, exit);
+    throw new Error(`Child_process exited with error code ${exit}`);
   } else {
     return;
   }
@@ -137,6 +130,7 @@ async function runAction(inputs: Inputs) {
   await validateInputs(inputs);
 
   for (let attempt = 1; attempt <= inputs.max_attempts; attempt++) {
+    info(`::group::Attempt ${attempt}`);
     try {
       // just keep overwriting attempts output
       setOutput(OUTPUT_TOTAL_ATTEMPTS_KEY, attempt);
@@ -145,9 +139,8 @@ async function runAction(inputs: Inputs) {
       break;
       // eslint-disable-next-line
     } catch (error: any) {
-      const exit = error instanceof ErrorWithCode ? error.code : 1;
       if (attempt === inputs.max_attempts) {
-        throw new ErrorWithCode(`Final attempt failed. ${error.message}`, exit);
+        throw new Error(`Final attempt failed. ${error.message}`);
       } else if (!done && inputs.retry_on === 'error') {
         // error: timeout
         throw error;
@@ -164,6 +157,8 @@ async function runAction(inputs: Inputs) {
           info(`Attempt ${attempt} failed. Reason: ${error.message}`);
         }
       }
+    } finally {
+      info(`::endgroup::`);
     }
   }
 }
@@ -176,7 +171,8 @@ runAction(inputs)
     process.exit(0); // success
   })
   .catch((err) => {
-    const exitCode = err instanceof ErrorWithCode ? err.code : 1;
+    // exact error code if available, otherwise just 1
+    const exitCode = exit > 0 ? exit : 1;
 
     if (inputs.continue_on_error) {
       warning(err.message);

src/util.test.ts

@@ -3,6 +3,11 @@ import { getHeapStatistics } from 'v8';
 
 import { wait } from './util';
 
+// otherwise, TypeError: Cannot assign to read only property 'performance' of object '[object global]'
+Object.defineProperty(global, 'performance', {
+  writable: true,
+});
+
 // mocks the setTimeout function, see https://jestjs.io/docs/timer-mocks
 jest.useFakeTimers();
 jest.spyOn(global, 'setTimeout');