[Snyk] Upgrade @actions/core from 1.8.2 to 1.9.0 (#81)

* fix: upgrade @actions/core from 1.8.2 to 1.9.0

Snyk has created this PR to upgrade @actions/core from 1.8.2 to 1.9.0.

See this package in npm:
https://www.npmjs.com/package/@actions/core

See this project in Snyk:
https://app.snyk.io/org/nick-invision/project/b960b937-66a3-4aae-9cb2-321f49c8750b?utm_source=github&utm_medium=referral&page=upgrade-pr

* patch: regenerate dist

Co-authored-by: Nick Fields <46869826+nick-fields@users.noreply.github.com>

.config/.eslintignore

@@ -0,0 +1 @@
+.eslintrc.js

.config/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
+  ignorePatterns: ['**/*.js', 'dist/'],
+};

.config/.prettierignore

@@ -0,0 +1,2 @@
+dist/
+node_modules/

.config/.prettierrc.yml

@@ -0,0 +1,5 @@
+trailingComma: 'es5'
+tabWidth: 2
+semi: true
+singleQuote: true
+printWidth: 100

.github/ISSUE_TEMPLATE/bug-report.md

@@ -4,7 +4,6 @@ about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: nick-invision
-
 ---
 
 **Describe the bug**

.github/workflows/ci_cd.yml

@@ -1,8 +1,7 @@
 name: CI/CD
 on:
   push:
-    branches:
+
-      - '**'
 jobs:
   # runs on branch pushes only
   ci:
@@ -15,7 +14,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 16
       - name: Install dependencies
         run: npm ci
 
@@ -60,6 +59,15 @@ jobs:
           actual: ${{ steps.sad_path_wait_sec.outputs.exit_error }}
           comparison: contains
 
+      - name: new-command-on-retry
+        id: new-command-on-retry
+        uses: ./
+        with:
+          timeout_minutes: 1
+          max_attempts: 3
+          command: node -e "process.exit(1)"
+          new_command_on_retry: node -e "console.log('this is the new command on retry')"
+
       - name: on-retry-cmd
         id: on-retry-cmd
         uses: ./
@@ -70,6 +78,42 @@ jobs:
           command: node -e "process.exit(1)"
           on_retry_command: node -e "console.log('this is a retry command')"
 
+      - name: retry_on_exit_code (with expected error code)
+        id: retry_on_exit_code_expected
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_minutes: 1
+          retry_on_exit_code: 2
+          max_attempts: 3
+          command: node -e "process.exit(2)"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.retry_on_exit_code_expected.outcome }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 3
+          actual: ${{ steps.retry_on_exit_code_expected.outputs.total_attempts }}
+
+      - name: retry_on_exit_code (with unexpected error code)
+        id: retry_on_exit_code_unexpected
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_minutes: 1
+          retry_on_exit_code: 2
+          max_attempts: 3
+          command: node -e "process.exit(1)"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.retry_on_exit_code_unexpected.outcome }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 1
+          actual: ${{ steps.retry_on_exit_code_unexpected.outputs.total_attempts }}
+
       - name: on-retry-cmd (on-retry fails)
         id: on-retry-cmd-fails
         uses: ./
@@ -279,7 +323,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 16
       - name: Install dependencies
         run: npm ci
       - name: Powershell test
@@ -333,7 +377,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 16
       - name: Install dependencies
         run: npm ci
       - name: Release

.husky/commit-msg

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# lint commit message
+npx --no -- commitlint --config ./.config/.commitlintrc.js --edit $1

.husky/pre-commit

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# run lint/styling on staged changes
+npx lint-staged
+
+# regenerate dist
+npm run prepare && git add .

.nvmrc

@@ -0,0 +1 @@
+v16.16.0

.prettierrc.js

@@ -1,7 +0,0 @@
-module.exports = {
-  tabWidth: 2,
-  printWidth: 100,
-  semi: true,
-  singleQuote: true,
-  trailingComma: 'es5',
-};

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode"]
+}

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
-  "prettier.requireConfig": true,
+  "prettier.configPath": "./.config/.prettierrc.yml",
-  "typescript.tsdk": "node_modules/typescript/lib",
+  "prettier.ignorePath": "./.config/.prettierignore",
-  "editor.tabSize": 2
+  "typescript.tsdk": "node_modules/typescript/lib"
 }

README.md

@@ -2,6 +2,10 @@
 
 Retries an Action step on failure or timeout. This is currently intended to replace the `run` step for moody commands.
 
+**NOTE:** Ownership of this project was transferred to my personal account `nick-fields` from my work account `nick-invision`. Details [here](#Ownership)
+
+---
+
 ## Inputs
 
 ### `timeout_minutes`
@@ -44,10 +48,18 @@ Retries an Action step on failure or timeout. This is currently intended to repl
 
 **Optional** Command to run before a retry (such as a cleanup script). Any error thrown from retry command is caught and surfaced as a warning.
 
+### `new_command_on_retry`
+
+**Optional** Command to run if the first attempt fails. This command will be called on all subsequent attempts.
+
 ### `continue_on_error`
 
 **Optional** Exit successfully even if an error occurs. Same as native continue-on-error behavior, but for use in composite actions. Defaults to `false`
 
+### `retry_on_exit_code`
+
+**Optional** Specific exit code to retry on. This will only retry for the given error code and fail immediately other error codes.
+
 ## Outputs
 
 ### `total_attempts`
@@ -67,7 +79,7 @@ The final error returned by the command
 ### Shell
 
 ```yaml
-uses: nick-invision/retry@v2
+uses: nick-fields/retry@v2
 with:
   timeout_minutes: 10
   max_attempts: 3
@@ -78,7 +90,7 @@ with:
 ### Timeout in minutes
 
 ```yaml
-uses: nick-invision/retry@v2
+uses: nick-fields/retry@v2
 with:
   timeout_minutes: 10
   max_attempts: 3
@@ -88,7 +100,7 @@ with:
 ### Timeout in seconds
 
 ```yaml
-uses: nick-invision/retry@v2
+uses: nick-fields/retry@v2
 with:
   timeout_seconds: 15
   max_attempts: 3
@@ -98,7 +110,7 @@ with:
 ### Only retry after timeout
 
 ```yaml
-uses: nick-invision/retry@v2
+uses: nick-fields/retry@v2
 with:
   timeout_seconds: 15
   max_attempts: 3
@@ -109,7 +121,7 @@ with:
 ### Only retry after error
 
 ```yaml
-uses: nick-invision/retry@v2
+uses: nick-fields/retry@v2
 with:
   timeout_seconds: 15
   max_attempts: 3
@@ -120,7 +132,7 @@ with:
 ### Retry using continue_on_error input (in composite action) but allow failure and do something with output
 
 ```yaml
-- uses: nick-invision/retry@v2
+- uses: nick-fields/retry@v2
   id: retry
   with:
     timeout_seconds: 15
@@ -128,12 +140,12 @@ with:
     continue_on_error: true
     command: node -e 'process.exit(99);'
 - name: Assert that step succeeded (despite failing command)
-  uses: nick-invision/assert-action@v1
+  uses: nick-fields/assert-action@v1
   with:
     expected: success
     actual: ${{ steps.retry.outcome }}
 - name: Assert that action exited with expected exit code
-  uses: nick-invision/assert-action@v1
+  uses: nick-fields/assert-action@v1
   with:
     expected: 99
     actual: ${{ steps.retry.outputs.exit_code }}
@@ -142,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-invision/retry@v2
+- uses: nick-fields/retry@v2
   id: retry
   # see https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontinue-on-error
   continue-on-error: true
@@ -152,17 +164,17 @@ with:
     retry_on: error
     command: node -e 'process.exit(99);'
 - name: Assert that action failed
-  uses: nick-invision/assert-action@v1
+  uses: nick-fields/assert-action@v1
   with:
     expected: failure
     actual: ${{ steps.retry.outcome }}
 - name: Assert that action exited with expected exit code
-  uses: nick-invision/assert-action@v1
+  uses: nick-fields/assert-action@v1
   with:
     expected: 99
     actual: ${{ steps.retry.outputs.exit_code }}
 - name: Assert that action made expected number of attempts
-  uses: nick-invision/assert-action@v1
+  uses: nick-fields/assert-action@v1
   with:
     expected: 3
     actual: ${{ steps.retry.outputs.total_attempts }}
@@ -171,7 +183,7 @@ with:
 ### Run script after failure but before retry
 
 ```yaml
-uses: nick-invision/retry@v2
+uses: nick-fields/retry@v2
 with:
   timeout_seconds: 15
   max_attempts: 3
@@ -179,6 +191,17 @@ with:
   on_retry_command: npm run cleanup-flaky-script-output
 ```
 
+### Run different command after first failure
+
+```yaml
+uses: nick-fields/retry@v2
+with:
+  timeout_seconds: 15
+  max_attempts: 3
+  command: npx jest
+  new_command_on_retry: npx jest --onlyFailures
+```
+
 ### Run multi-line, multi-command script
 
 ```yaml
@@ -209,3 +232,11 @@ with:
 ## Requirements
 
 NodeJS is required for this action to run. This runs without issue on all GitHub hosted runners but if you are running into issues with this on self hosted runners ensure NodeJS is installed.
+
+---
+
+## **Ownership**
+
+As of 2022/02/15 ownership of this project has been transferred to my personal account `nick-fields` from my work account `nick-invision` due to me leaving InVision. I am the author and have been the primary maintainer since day one and will continue to maintain this as needed.
+
+Existing workflow references to `nick-invision/retry@<whatever>` no longer work and must be updated to `nick-fields/retry@<whatever>`.

action.yml

@@ -36,6 +36,12 @@ inputs:
   continue_on_error:
     description: Exits successfully even if an error occurs.  Same as native continue-on-error behavior, but for use in composite actions. Default is false
     default: false
+  new_command_on_retry:
+    description: Command to run if the first attempt fails. This command will be called on all subsequent attempts.
+    required: false
+  retry_on_exit_code:
+    description: Specific exit code to retry on. This will only retry for the given error code and fail immediately other error codes.
+    required: false
 outputs:
   total_attempts:
     description: The final number of attempts made

package.json

@@ -3,43 +3,56 @@
   "version": "0.0.0-managed-by-semantic-release",
   "description": "Retries a GitHub Action step on failure or timeout.",
   "scripts": {
+    "lint:base": "eslint --config ./.config/.eslintrc.js ",
+    "lint": "npm run lint:base -- .",
     "local": "npm run prepare && node -r dotenv/config ./dist/index.js",
-    "prepare": "ncc build src/index.ts"
+    "prepare": "ncc build src/index.ts && husky install",
+    "style:base": "prettier --config ./.config/.prettierrc.yml --ignore-path ./.config/.prettierignore --write ",
+    "style": "npm run style:base -- ."
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nick-invision/retry.git"
   },
   "keywords": [],
-  "author": "",
+  "author": "Nick Fields",
   "license": "ISC",
   "bugs": {
     "url": "https://github.com/nick-invision/retry/issues"
   },
   "homepage": "https://github.com/nick-invision/retry#readme",
   "dependencies": {
-    "@actions/core": "^1.5.0",
+    "@actions/core": "^1.9.0",
     "milliseconds": "^1.0.3",
     "tree-kill": "^1.2.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "11.0.0",
+    "@commitlint/cli": "^16.2.3",
-    "@commitlint/config-conventional": "11.0.0",
+    "@commitlint/config-conventional": "^16.2.1",
-    "@semantic-release/changelog": "5.0.1",
+    "@semantic-release/changelog": "^6.0.1",
-    "@semantic-release/git": "9.0.0",
+    "@semantic-release/git": "^10.0.1",
     "@types/milliseconds": "0.0.30",
-    "@types/node": "14.14.7",
+    "@types/node": "^16.11.7",
+    "@typescript-eslint/eslint-plugin": "^5.32.0",
+    "@typescript-eslint/parser": "^5.32.0",
     "@zeit/ncc": "^0.20.5",
     "dotenv": "8.2.0",
-    "husky": "4.3.0",
+    "eslint": "^8.21.0",
-    "semantic-release": "17.2.3",
+    "eslint-config-prettier": "^8.5.0",
+    "husky": "^8.0.1",
+    "lint-staged": "^13.0.3",
+    "prettier": "^2.7.1",
+    "semantic-release": "19.0.3",
     "ts-node": "9.0.0",
-    "typescript": "4.0.5"
+    "typescript": "^4.7.4"
   },
-  "husky": {
+  "lint-staged": {
-    "hooks": {
+    "**/*.ts": [
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+      "npm run style:base --",
-      "pre-commit": "npm run prepare && git add ."
+      "npm run lint:base --"
-    }
+    ],
+    "**/*.{md,yaml,yml}": [
+      "npm run style:base --"
+    ]
   }
 }

src/index.ts

@@ -17,14 +17,16 @@ const RETRY_ON = getInput('retry_on') || 'any';
 const WARNING_ON_RETRY = getInput('warning_on_retry').toLowerCase() === 'true';
 const ON_RETRY_COMMAND = getInput('on_retry_command');
 const CONTINUE_ON_ERROR = getInputBoolean('continue_on_error');
+const NEW_COMMAND_ON_RETRY = getInput('new_command_on_retry');
+const RETRY_ON_EXIT_CODE = getInputNumber('retry_on_exit_code', false);
 
 const OS = process.platform;
 const OUTPUT_TOTAL_ATTEMPTS_KEY = 'total_attempts';
 const OUTPUT_EXIT_CODE_KEY = 'exit_code';
 const OUTPUT_EXIT_ERROR_KEY = 'exit_error';
 
-var exit: number;
+let exit: number;
-var done: boolean;
+let done: boolean;
 
 function getInputNumber(id: string, required: boolean): number | undefined {
   const input = getInput(id, { required });
@@ -42,13 +44,13 @@ function getInputNumber(id: string, required: boolean): number | undefined {
   return num;
 }
 
-function getInputBoolean(id: string): Boolean {
+function getInputBoolean(id: string): boolean {
   const input = getInput(id);
 
-  if (!['true','false'].includes(input.toLowerCase())) {
+  if (!['true', 'false'].includes(input.toLowerCase())) {
     throw `Input ${id} only accepts boolean values.  Received ${input}`;
   }
-  return input.toLowerCase() === 'true'
+  return input.toLowerCase() === 'true';
 }
 
 async function retryWait() {
@@ -81,32 +83,34 @@ function getExecutable(): string {
 
   let executable: string;
   switch (SHELL) {
-    case "bash":
+    case 'bash':
-    case "python":
+    case 'python':
-    case "pwsh": {
+    case 'pwsh': {
       executable = SHELL;
       break;
     }
-    case "sh": {
+    case 'sh': {
       if (OS === 'win32') {
         throw new Error(`Shell ${SHELL} not allowed on OS ${OS}`);
       }
       executable = SHELL;
       break;
     }
-    case "cmd":
+    case 'cmd':
-    case "powershell": {
+    case 'powershell': {
       if (OS !== 'win32') {
         throw new Error(`Shell ${SHELL} not allowed on OS ${OS}`);
       }
-      executable = SHELL + ".exe";
+      executable = SHELL + '.exe';
       break;
     }
     default: {
-      throw new Error(`Shell ${SHELL} not supported.  See https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell for supported shells`);
+      throw new Error(
+        `Shell ${SHELL} not supported.  See https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell for supported shells`
+      );
     }
   }
-  return executable
+  return executable;
 }
 
 async function runRetryCmd(): Promise<void> {
@@ -117,20 +121,24 @@ async function runRetryCmd(): Promise<void> {
 
   try {
     await execSync(ON_RETRY_COMMAND, { stdio: 'inherit' });
-  } catch (error) {
+    // eslint-disable-next-line
-    info(`WARNING: Retry command threw the error ${error.message}`)
+  } catch (error: any) {
+    info(`WARNING: Retry command threw the error ${error.message}`);
   }
 }
 
-async function runCmd() {
+async function runCmd(attempt: number) {
   const end_time = Date.now() + getTimeout();
   const executable = getExecutable();
 
   exit = 0;
   done = false;
 
-  debug(`Running command ${COMMAND} on ${OS} using shell ${executable}`)
+  debug(`Running command ${COMMAND} on ${OS} using shell ${executable}`);
-  var child = exec(COMMAND, { 'shell': executable });
+  const child =
+    attempt > 1 && NEW_COMMAND_ON_RETRY
+      ? exec(NEW_COMMAND_ON_RETRY, { shell: executable })
+      : exec(COMMAND, { shell: executable });
 
   child.stdout?.on('data', (data) => {
     process.stdout.write(data);
@@ -156,7 +164,7 @@ async function runCmd() {
     await wait(ms.seconds(POLLING_INTERVAL_SECONDS));
   } while (Date.now() < end_time && !done);
 
-  if (!done) {
+  if (!done && child.pid) {
     kill(child.pid);
     await retryWait();
     throw new Error(`Timeout of ${getTimeout()}ms hit`);
@@ -175,15 +183,18 @@ async function runAction() {
     try {
       // just keep overwriting attempts output
       setOutput(OUTPUT_TOTAL_ATTEMPTS_KEY, attempt);
-      await runCmd();
+      await runCmd(attempt);
       info(`Command completed after ${attempt} attempt(s).`);
       break;
-    } catch (error) {
+      // eslint-disable-next-line
+    } catch (error: any) {
       if (attempt === MAX_ATTEMPTS) {
         throw new Error(`Final attempt failed. ${error.message}`);
       } else if (!done && RETRY_ON === 'error') {
         // error: timeout
         throw error;
+      } else if (RETRY_ON_EXIT_CODE && RETRY_ON_EXIT_CODE !== exit) {
+        throw error;
       } else if (exit > 0 && RETRY_ON === 'timeout') {
         // error: error
         throw error;