fix: upgrade @actions/core from 1.9.0 to 1.9.1

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

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

.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

.config/jest.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+  clearMocks: true,
+  moduleFileExtensions: ['js', 'ts'],
+  rootDir: '..',
+  testEnvironment: 'node',
+  testMatch: ['<rootDir>/src/**/*.test.ts'],
+  transform: {
+    '^.+\\.ts$': 'ts-jest',
+  },
+  verbose: true,
+  collectCoverage: true,
+  collectCoverageFrom: ['src/**/*.{js,ts,jsx,tsx}'],
+};

.github/ISSUE_TEMPLATE/bug-report.md

@@ -3,8 +3,7 @@ name: Bug report
 about: Create a report to help us improve
 title: ''
 labels: ''
-assignees: nick-invision
-
+assignees: nick-fields
 ---
 
 **Describe the bug**

.github/codecov.yml

@@ -0,0 +1,12 @@
+# see https://docs.codecov.com/docs/codecovyml-reference
+codecov:
+  require_ci_to_pass: false
+comment:
+  layout: 'diff, flags'
+  behavior: default
+  require_changes: true
+coverage:
+  # don't pass/fail PRs for coverage yet
+  status:
+    project: off
+    patch: off

.github/pull_request_template.md

@@ -0,0 +1,10 @@
+_Replace the bullet points below with your answers_
+
+### Description
+
+- What change is being made and why?
+
+### Testing
+
+- What tests were added?
+  - These can be either ["integration tests"](./workflows/ci_cd.yml) or unit tests

.github/workflows/ci_cd.yml

@@ -1,21 +1,40 @@
 name: CI/CD
 on:
   push:
-    branches:
-      - '**'
+
 jobs:
   # runs on branch pushes only
-  ci:
-    name: Run Tests
+  ci_unit:
+    name: Run Unit Tests
     if: startsWith(github.ref, 'refs/heads')
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Setup Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+      - name: Run Unit Tests
+        run: npm test
+      - uses: codecov/codecov-action@v3
+        with:
+          directory: ./coverage/
+          verbose: true
+
+  ci_integration:
+    name: Run Integration Tests
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
       - name: Install dependencies
         run: npm ci
 
@@ -37,29 +56,6 @@ jobs:
           command: node ./.github/scripts/log-examples.js
           timeout_minutes: 1
 
-      - name: sad-path (retry_wait_seconds)
-        id: sad_path_wait_sec
-        uses: ./
-        continue-on-error: true
-        with:
-          timeout_minutes: 1
-          max_attempts: 3
-          retry_wait_seconds: 15
-          command: npm install this-isnt-a-real-package-name-zzz
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: 3
-          actual: ${{ steps.sad_path_wait_sec.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: failure
-          actual: ${{ steps.sad_path_wait_sec.outcome }}
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: 'Final attempt failed'
-          actual: ${{ steps.sad_path_wait_sec.outputs.exit_error }}
-          comparison: contains
-
       - name: sad-path (error)
         id: sad_path_error
         uses: ./
@@ -121,8 +117,270 @@ jobs:
           expected: 2
           actual: ${{ steps.retry_on_error.outputs.exit_code }}
 
+      - name: sad-path (wrong shell for OS)
+        id: wrong_shell
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_minutes: 1
+          max_attempts: 2
+          shell: cmd
+          command: 'dir'
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.wrong_shell.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.wrong_shell.outcome }}
+
+  ci_integration_envvar:
+    name: Run Integration Env Var Tests
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+      - name: env-vars-passed-through
+        uses: ./
+        env:
+          NODE_OPTIONS: '--max_old_space_size=3072'
+        with:
+          timeout_minutes: 1
+          max_attempts: 2
+          command: node -e 'console.log(process.env.NODE_OPTIONS)'
+
+  ci_integration_large_output:
+    name: Run Integration Large Output Tests
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+      - name: Test 100MiB of output can be processed
+        id: large-output
+        continue-on-error: true
+        uses: ./
+        with:
+          max_attempts: 1
+          timeout_minutes: 5
+          command: 'make -C ./test-data/large-output bytes-102400'
+      - name: Assert test had expected result
+        uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.large-output.outcome }}
+      - name: Assert exit code is expected
+        uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.large-output.outputs.exit_code }}
+
+  ci_integration_retry_on_exit_code:
+    name: Run Integration retry_on_exit_code Tests
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+      - 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 }}
+
+  ci_integration_continue_on_error:
+    name: Run Integration continue_on_error Tests
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+      - name: happy-path (continue_on_error)
+        id: happy_path_continue_on_error
+        uses: ./
+        with:
+          command: node -e "process.exit(0)"
+          timeout_minutes: 1
+          continue_on_error: true
+      - name: sad-path (continue_on_error)
+        id: sad_path_continue_on_error
+        uses: ./
+        with:
+          command: node -e "process.exit(33)"
+          timeout_minutes: 1
+          continue_on_error: true
+      - name: Verify continue_on_error returns correct exit code on success
+        uses: nick-invision/assert-action@v1
+        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
+        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
+        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
+        with:
+          expected: success
+          actual: ${{ steps.sad_path_continue_on_error.outcome }}
+
+  ci_integration_retry_wait_seconds:
+    name: Run Integration Tests (retry_wait_seconds)
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+
+      - name: sad-path (retry_wait_seconds)
+        id: sad_path_wait_sec
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_minutes: 1
+          max_attempts: 3
+          retry_wait_seconds: 15
+          command: npm install this-isnt-a-real-package-name-zzz
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 3
+          actual: ${{ steps.sad_path_wait_sec.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.sad_path_wait_sec.outcome }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 'Final attempt failed'
+          actual: ${{ steps.sad_path_wait_sec.outputs.exit_error }}
+          comparison: contains
+
+  ci_integration_on_retry_cmd:
+    name: Run Integration Tests (on_retry_command)
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+
+      - 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: ./
+        continue-on-error: true
+        with:
+          timeout_minutes: 1
+          max_attempts: 3
+          command: node -e "process.exit(1)"
+          on_retry_command: node -e "console.log('this is a retry command')"
+
+      - name: on-retry-cmd (on-retry fails)
+        id: on-retry-cmd-fails
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_minutes: 1
+          max_attempts: 3
+          command: node -e "process.exit(1)"
+          on_retry_command: node -e "throw new Error('This is an on-retry command error')"
+
+  # timeout tests take longer to run so run in parallel
+  ci_integration_timeout_seconds:
+    name: Run Integration Timeout Tests (seconds)
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
 
-        # timeout tests (takes longer to run so run last)
       - name: sad-path (timeout)
         id: sad_path_timeout
         uses: ./
@@ -140,6 +398,20 @@ jobs:
           expected: failure
           actual: ${{ steps.sad_path_timeout.outcome }}
 
+  ci_integration_timeout_retry_on_timeout:
+    name: Run Integration Timeout Tests (retry_on timeout)
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+
       - name: retry_on (timeout)
         id: retry_on_timeout
         uses: ./
@@ -158,6 +430,20 @@ jobs:
           expected: failure
           actual: ${{ steps.retry_on_timeout.outcome }}
 
+  ci_integration_timeout_retry_on_error:
+    name: Run Integration Timeout Tests (retry_on error)
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+
       - name: retry_on (error) fails early if timeout encountered
         id: retry_on_error_fail
         uses: ./
@@ -180,6 +466,20 @@ jobs:
           expected: 1
           actual: ${{ steps.retry_on_error_fail.outputs.exit_code }}
 
+  ci_integration_timeout_minutes:
+    name: Run Integration Timeout Tests (minutes)
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+
       - name: sad-path (timeout minutes)
         id: sad_path_timeout_minutes
         uses: ./
@@ -191,25 +491,99 @@ jobs:
       - uses: nick-invision/assert-action@v1
         with:
           expected: 2
-          actual: ${{ steps.sad_path_timeout.outputs.total_attempts }}
+          actual: ${{ steps.sad_path_timeout_minutes.outputs.total_attempts }}
       - uses: nick-invision/assert-action@v1
         with:
           expected: failure
-          actual: ${{ steps.sad_path_timeout.outcome }}
+          actual: ${{ steps.sad_path_timeout_minutes.outcome }}
 
-  # runs on push to master only
-  cd:
-    name: Publish Action
-    needs: ci
-    if: github.ref == 'refs/heads/master'
-    runs-on: ubuntu-18.04
+  ci_windows:
+    name: Run Windows Tests
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: windows-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v2
       - 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
+        uses: ./
+        with:
+          timeout_minutes: 1
+          max_attempts: 2
+          shell: powershell
+          command: Get-ComputerInfo
+      - name: CMD.exe test
+        uses: ./
+        with:
+          timeout_minutes: 1
+          max_attempts: 2
+          shell: cmd
+          command: echo %PATH%
+      - name: Python test
+        uses: ./
+        with:
+          timeout_minutes: 1
+          max_attempts: 2
+          shell: python
+          command: print('1', '2', '3')
+      - name: Multi-line multi-command Test
+        uses: ./
+        with:
+          timeout_minutes: 1
+          max_attempts: 2
+          command: |
+            Get-ComputerInfo
+            Get-Date
+      - name: Multi-line single-command Test
+        uses: ./
+        with:
+          timeout_minutes: 1
+          max_attempts: 2
+          shell: cmd
+          command: >-
+            echo "this is
+            a test"
+
+  ci_all_tests_passed:
+    name: All tests passed
+    needs:
+      [
+        ci_unit,
+        ci_integration,
+        ci_integration_envvar,
+        ci_integration_large_output,
+        ci_integration_on_retry_cmd,
+        ci_integration_retry_wait_seconds,
+        ci_integration_continue_on_error,
+        ci_integration_retry_on_exit_code,
+        ci_integration_timeout_seconds,
+        ci_integration_timeout_minutes,
+        ci_integration_timeout_retry_on_timeout,
+        ci_integration_timeout_retry_on_error,
+        ci_windows,
+      ]
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "If this is hit, all tests successfully passed"
+
+  # runs on push to master only
+  cd:
+    name: Publish Action
+    needs: [ci_all_tests_passed]
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          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',
-};

.releaserc.js

@@ -8,6 +8,7 @@ module.exports = {
           { type: 'minor', release: 'minor' },
           { type: 'major', release: 'major' },
           { type: 'patch', release: 'patch' },
+          { type: 'test', release: false },
           { scope: 'no-release', release: false },
         ],
       },

.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,
-  "typescript.tsdk": "node_modules/typescript/lib",
-  "editor.tabSize": 2
+  "prettier.configPath": "./.config/.prettierrc.yml",
+  "prettier.ignorePath": "./.config/.prettierignore",
+  "typescript.tsdk": "node_modules/typescript/lib"
 }

README.md

@@ -2,11 +2,19 @@
 
 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`
 
-**Required** Minutes to wait before attempt times out
+**Required** Minutes to wait before attempt times out. Must only specify either minutes or seconds
+
+### `timeout_seconds`
+
+**Required** Seconds to wait before attempt times out. Must only specify either minutes or seconds
 
 ### `max_attempts`
 
@@ -20,6 +28,10 @@ Retries an Action step on failure or timeout. This is currently intended to repl
 
 **Optional** Number of seconds to wait before attempting the next retry. Defaults to `10`
 
+### `shell`
+
+**Optional** Shell to use to execute `command`. Defaults to `powershell` on Windows, `bash` otherwise. Supports bash, python, pwsh, sh, cmd, and powershell per [docs](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell)
+
 ### `polling_interval_seconds`
 
 **Optional** Number of seconds to wait while polling for command result. Defaults to `1`
@@ -28,6 +40,26 @@ Retries an Action step on failure or timeout. This is currently intended to repl
 
 **Optional** Event to retry on. Currently supports [any (default), timeout, error].
 
+### `warning_on_retry`
+
+**Optional** Whether to output a warning on retry, or just output to info. Defaults to `true`.
+
+### `on_retry_command`
+
+**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`
@@ -44,10 +76,21 @@ The final error returned by the command
 
 ## Examples
 
+### Shell
+
+```yaml
+uses: nick-fields/retry@v2
+with:
+  timeout_minutes: 10
+  max_attempts: 3
+  shell: pwsh
+  command: dir
+```
+
 ### Timeout in minutes
 
 ```yaml
-uses: nick-invision/retry@v2
+uses: nick-fields/retry@v2
 with:
   timeout_minutes: 10
   max_attempts: 3
@@ -57,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
@@ -67,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
@@ -78,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
@@ -86,10 +129,32 @@ with:
   command: npm run some-typically-fast-script
 ```
 
-### Retry but allow failure and do something with output
+### 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
+    max_attempts: 3
+    continue_on_error: true
+    command: node -e 'process.exit(99);'
+- name: Assert that step succeeded (despite failing command)
+  uses: nick-fields/assert-action@v1
+  with:
+    expected: success
+    actual: ${{ steps.retry.outcome }}
+- name: Assert that action exited with expected exit code
+  uses: nick-fields/assert-action@v1
+  with:
+    expected: 99
+    actual: ${{ steps.retry.outputs.exit_code }}
+```
+
+### 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
   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
@@ -99,22 +164,79 @@ 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 }}
 ```
 
+### Run script after failure but before retry
+
+```yaml
+uses: nick-fields/retry@v2
+with:
+  timeout_seconds: 15
+  max_attempts: 3
+  command: npm run some-flaky-script-that-outputs-something
+  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
+name: Multi-line multi-command Test
+uses: ./
+with:
+  timeout_minutes: 1
+  max_attempts: 2
+  command: |
+    Get-ComputerInfo
+    Get-Date
+```
+
+### Run multi-line, single-command script
+
+```yaml
+name: Multi-line single-command Test
+uses: ./
+with:
+  timeout_minutes: 1
+  max_attempts: 2
+  shell: cmd
+  command: >-
+    echo "this is
+ a test"
+```
+
 ## 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

@@ -18,12 +18,30 @@ inputs:
     description: Number of seconds to wait before attempting the next retry
     required: false
     default: 10
+  shell:
+    description: Alternate shell to use (defaults to powershell on windows, bash otherwise).  Supports bash, python, pwsh, sh, cmd, and powershell
+    required: false
   polling_interval_seconds:
     description: Number of seconds to wait for each check that command has completed running
     required: false
     default: 1
   retry_on:
     description: Event to retry on.  Currently supported [any, timeout, error]
+  warning_on_retry:
+    description: Whether to output a warning on retry, or just output to info. Defaults to true
+    default: true
+  on_retry_command:
+    description: Command to run before a retry (such as a cleanup script).  Any error thrown from retry command is caught and surfaced as a warning.
+    required: false
+  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,64 @@
   "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 -- .",
+    "test": "jest -c ./.config/jest.config.js"
   },
   "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.2.6",
+    "@actions/core": "^1.9.1",
     "milliseconds": "^1.0.3",
     "tree-kill": "^1.2.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "11.0.0",
-    "@commitlint/config-conventional": "11.0.0",
-    "@semantic-release/changelog": "5.0.1",
-    "@semantic-release/git": "9.0.0",
+    "@commitlint/cli": "^16.2.3",
+    "@commitlint/config-conventional": "^16.2.1",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@types/jest": "^28.1.6",
     "@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",
-    "semantic-release": "17.2.2",
+    "eslint": "^8.21.0",
+    "eslint-config-prettier": "^8.5.0",
+    "husky": "^8.0.1",
+    "jest": "^28.1.3",
+    "lint-staged": "^13.0.3",
+    "prettier": "^2.7.1",
+    "semantic-release": "19.0.3",
+    "ts-jest": "^28.0.7",
     "ts-node": "9.0.0",
-    "typescript": "4.0.5"
+    "typescript": "^4.7.4",
+    "yaml-lint": "^1.7.0"
   },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-      "pre-commit": "npm run prepare && git add ."
-    }
+  "lint-staged": {
+    "**/*.ts": [
+      "npm run style:base --",
+      "npm run lint:base --"
+    ],
+    "**/*.{md,yaml,yml}": [
+      "npm run style:base --"
+    ],
+    "**/*.{yaml,yml}": [
+      "npx yamllint "
+    ]
   }
 }

sample.env

@@ -1,6 +1,11 @@
+# these are the bare minimum envvars required
 INPUT_TIMEOUT_MINUTES=1
 INPUT_MAX_ATTEMPTS=3
 INPUT_COMMAND="node -e 'process.exit(99)'"
-INPUT_RETRY_WAIT_SECONDS=10
-INPUT_POLLING_INTERVAL_SECONDS=1
-INPUT_RETRY_ON=any
+INPUT_CONTINUE_ON_ERROR=false
+
+# these are optional
+#INPUT_RETRY_WAIT_SECONDS=10
+#SHELL=pwsh
+#INPUT_POLLING_INTERVAL_SECONDS=1
+#INPUT_RETRY_ON=any

src/index.ts

@@ -1,78 +1,82 @@
-import { getInput, error, warning, info, debug, setOutput } from '@actions/core';
-import { exec } from 'child_process';
+import { error, warning, info, debug, setOutput } from '@actions/core';
+import { execSync, spawn } from 'child_process';
 import ms from 'milliseconds';
 import kill from 'tree-kill';
 
-import { wait } from './util';
-
-// inputs
-const TIMEOUT_MINUTES = getInputNumber('timeout_minutes', false);
-const TIMEOUT_SECONDS = getInputNumber('timeout_seconds', false);
-const MAX_ATTEMPTS = getInputNumber('max_attempts', true) || 3;
-const COMMAND = getInput('command', { required: true });
-const RETRY_WAIT_SECONDS = getInputNumber('retry_wait_seconds', false) || 10;
-const POLLING_INTERVAL_SECONDS = getInputNumber('polling_interval_seconds', false) || 1;
-const RETRY_ON = getInput('retry_on') || 'any';
+import { getInputs, getTimeout, Inputs, validateInputs } from './inputs';
+import { retryWait, wait } from './util';
 
+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;
-var done: boolean;
+let exit: number;
+let done: boolean;
 
-function getInputNumber(id: string, required: boolean): number | undefined {
-  const input = getInput(id, { required });
-  const num = Number.parseInt(input);
+function getExecutable(inputs: Inputs): string {
+  if (!inputs.shell) {
+    return OS === 'win32' ? 'powershell' : 'bash';
+  }
 
-  // empty is ok
-  if (!input && !required) {
+  let executable: string;
+  switch (inputs.shell) {
+    case 'bash':
+    case 'python':
+    case 'pwsh': {
+      executable = inputs.shell;
+      break;
+    }
+    case 'sh': {
+      if (OS === 'win32') {
+        throw new Error(`Shell ${inputs.shell} not allowed on OS ${OS}`);
+      }
+      executable = inputs.shell;
+      break;
+    }
+    case 'cmd':
+    case 'powershell': {
+      if (OS !== 'win32') {
+        throw new Error(`Shell ${inputs.shell} not allowed on OS ${OS}`);
+      }
+      executable = inputs.shell + '.exe';
+      break;
+    }
+    default: {
+      throw new Error(
+        `Shell ${inputs.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;
+}
+
+async function runRetryCmd(inputs: Inputs): Promise<void> {
+  // if no retry script, just continue
+  if (!inputs.on_retry_command) {
     return;
   }
 
-  if (!Number.isInteger(num)) {
-    throw `Input ${id} only accepts numbers.  Received ${input}`;
-  }
-
-  return num;
-}
-
-async function retryWait() {
-  const waitStart = Date.now();
-  await wait(ms.seconds(RETRY_WAIT_SECONDS));
-  debug(`Waited ${Date.now() - waitStart}ms`);
-  debug(`Configured wait: ${ms.seconds(RETRY_WAIT_SECONDS)}ms`);
-}
-
-async function validateInputs() {
-  if ((!TIMEOUT_MINUTES && !TIMEOUT_SECONDS) || (TIMEOUT_MINUTES && TIMEOUT_SECONDS)) {
-    throw new Error('Must specify either timeout_minutes or timeout_seconds inputs');
-  }
-
-  if (TIMEOUT_SECONDS && TIMEOUT_SECONDS < RETRY_WAIT_SECONDS) {
-    throw new Error(
-      `timeout_seconds ${TIMEOUT_SECONDS}s less than retry_wait_seconds ${RETRY_WAIT_SECONDS}s`
-    );
+  try {
+    await execSync(inputs.on_retry_command, { stdio: 'inherit' });
+    // eslint-disable-next-line
+  } catch (error: any) {
+    info(`WARNING: Retry command threw the error ${error.message}`);
   }
 }
 
-function getTimeout(): number {
-  if (TIMEOUT_MINUTES) {
-    return ms.minutes(TIMEOUT_MINUTES);
-  } else if (TIMEOUT_SECONDS) {
-    return ms.seconds(TIMEOUT_SECONDS);
-  }
-
-  throw new Error('Must specify either timeout_minutes or timeout_seconds inputs');
-}
-
-async function runCmd() {
-  const end_time = Date.now() + getTimeout();
+async function runCmd(attempt: number, inputs: Inputs) {
+  const end_time = Date.now() + getTimeout(inputs);
+  const executable = getExecutable(inputs);
 
   exit = 0;
   done = false;
 
-  var child = exec(COMMAND);
+  debug(`Running command ${inputs.command} on ${OS} using shell ${executable}`);
+  const child =
+    attempt > 1 && inputs.new_command_on_retry
+      ? spawn(inputs.new_command_on_retry, { shell: executable })
+      : spawn(inputs.command, { shell: executable });
 
   child.stdout?.on('data', (data) => {
     process.stdout.write(data);
@@ -95,59 +99,77 @@ async function runCmd() {
   });
 
   do {
-    await wait(ms.seconds(POLLING_INTERVAL_SECONDS));
+    await wait(ms.seconds(inputs.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`);
+    await retryWait(ms.seconds(inputs.retry_wait_seconds));
+    throw new Error(`Timeout of ${getTimeout(inputs)}ms hit`);
   } else if (exit > 0) {
-    await retryWait();
+    await retryWait(ms.seconds(inputs.retry_wait_seconds));
     throw new Error(`Child_process exited with error code ${exit}`);
   } else {
     return;
   }
 }
 
-async function runAction() {
-  await validateInputs();
+async function runAction(inputs: Inputs) {
+  await validateInputs(inputs);
 
-  for (let attempt = 1; attempt <= MAX_ATTEMPTS; attempt++) {
+  for (let attempt = 1; attempt <= inputs.max_attempts; attempt++) {
     try {
       // just keep overwriting attempts output
       setOutput(OUTPUT_TOTAL_ATTEMPTS_KEY, attempt);
-      await runCmd();
+      await runCmd(attempt, inputs);
       info(`Command completed after ${attempt} attempt(s).`);
       break;
-    } catch (error) {
-      if (attempt === MAX_ATTEMPTS) {
+      // eslint-disable-next-line
+    } catch (error: any) {
+      if (attempt === inputs.max_attempts) {
         throw new Error(`Final attempt failed. ${error.message}`);
-      } else if (!done && RETRY_ON === 'error') {
+      } else if (!done && inputs.retry_on === 'error') {
         // error: timeout
         throw error;
-      } else if (exit > 0 && RETRY_ON === 'timeout') {
+      } else if (inputs.retry_on_exit_code && inputs.retry_on_exit_code !== exit) {
+        throw error;
+      } else if (exit > 0 && inputs.retry_on === 'timeout') {
         // error: error
         throw error;
       } else {
+        await runRetryCmd(inputs);
+        if (inputs.warning_on_retry) {
           warning(`Attempt ${attempt} failed. Reason: ${error.message}`);
+        } else {
+          info(`Attempt ${attempt} failed. Reason: ${error.message}`);
+        }
       }
     }
   }
 }
 
-runAction()
+const inputs = getInputs();
+
+runAction(inputs)
   .then(() => {
     setOutput(OUTPUT_EXIT_CODE_KEY, 0);
     process.exit(0); // success
   })
   .catch((err) => {
+    // exact error code if available, otherwise just 1
+    const exitCode = exit > 0 ? exit : 1;
+
+    if (inputs.continue_on_error) {
+      warning(err.message);
+    } else {
       error(err.message);
+    }
 
     // these can be  helpful to know if continue-on-error is true
     setOutput(OUTPUT_EXIT_ERROR_KEY, err.message);
-    setOutput(OUTPUT_EXIT_CODE_KEY, exit > 0 ? exit : 1);
+    setOutput(OUTPUT_EXIT_CODE_KEY, exitCode);
 
-    // exit with exact error code if available, otherwise just exit with 1
-    process.exit(exit > 0 ? exit : 1);
+    // if continue_on_error, exit with exact error code else exit gracefully
+    // mimics native continue-on-error that is not supported in composite actions
+    process.exit(inputs.continue_on_error ? 0 : exitCode);
   });

src/inputs.ts

@@ -0,0 +1,94 @@
+import { getInput } from '@actions/core';
+import ms from 'milliseconds';
+
+export interface Inputs {
+  timeout_minutes: number | undefined;
+  timeout_seconds: number | undefined;
+  max_attempts: number;
+  command: string;
+  retry_wait_seconds: number;
+  shell: string | undefined;
+  polling_interval_seconds: number;
+  retry_on: string | undefined;
+  warning_on_retry: boolean;
+  on_retry_command: string | undefined;
+  continue_on_error: boolean;
+  new_command_on_retry: string | undefined;
+  retry_on_exit_code: number | undefined;
+}
+
+export function getInputNumber(id: string, required: boolean): number | undefined {
+  const input = getInput(id, { required });
+  const num = Number.parseInt(input);
+
+  // empty is ok
+  if (!input && !required) {
+    return;
+  }
+
+  if (!Number.isInteger(num)) {
+    throw `Input ${id} only accepts numbers.  Received ${input}`;
+  }
+
+  return num;
+}
+
+export function getInputBoolean(id: string): boolean {
+  const input = getInput(id);
+
+  if (!['true', 'false'].includes(input.toLowerCase())) {
+    throw `Input ${id} only accepts boolean values.  Received ${input}`;
+  }
+  return input.toLowerCase() === 'true';
+}
+
+export async function validateInputs(inputs: Inputs) {
+  if (
+    (!inputs.timeout_minutes && !inputs.timeout_seconds) ||
+    (inputs.timeout_minutes && inputs.timeout_seconds)
+  ) {
+    throw new Error('Must specify either timeout_minutes or timeout_seconds inputs');
+  }
+}
+
+export function getTimeout(inputs: Inputs): number {
+  if (inputs.timeout_minutes) {
+    return ms.minutes(inputs.timeout_minutes);
+  } else if (inputs.timeout_seconds) {
+    return ms.seconds(inputs.timeout_seconds);
+  }
+
+  throw new Error('Must specify either timeout_minutes or timeout_seconds inputs');
+}
+
+export function getInputs(): Inputs {
+  const timeout_minutes = getInputNumber('timeout_minutes', false);
+  const timeout_seconds = getInputNumber('timeout_seconds', false);
+  const max_attempts = getInputNumber('max_attempts', true) || 3;
+  const command = getInput('command', { required: true });
+  const retry_wait_seconds = getInputNumber('retry_wait_seconds', false) || 10;
+  const shell = getInput('shell');
+  const polling_interval_seconds = getInputNumber('polling_interval_seconds', false) || 1;
+  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);
+
+  return {
+    timeout_minutes,
+    timeout_seconds,
+    max_attempts,
+    command,
+    retry_wait_seconds,
+    shell,
+    polling_interval_seconds,
+    retry_on,
+    warning_on_retry,
+    on_retry_command,
+    continue_on_error,
+    new_command_on_retry,
+    retry_on_exit_code,
+  };
+}

src/util.test.ts

@@ -0,0 +1,17 @@
+import 'jest';
+import { getHeapStatistics } from 'v8';
+
+import { wait } from './util';
+
+// mocks the setTimeout function, see https://jestjs.io/docs/timer-mocks
+jest.useFakeTimers();
+jest.spyOn(global, 'setTimeout');
+
+describe('util', () => {
+  test('wait', async () => {
+    const waitTime = 1000;
+    wait(waitTime);
+    expect(setTimeout).toHaveBeenCalledTimes(1);
+    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), waitTime);
+  });
+});

src/util.ts

@@ -1,3 +1,12 @@
+import { debug } from '@actions/core';
+
 export async function wait(ms: number) {
   return new Promise((r) => setTimeout(r, ms));
 }
+
+export async function retryWait(retryWaitSeconds: number) {
+  const waitStart = Date.now();
+  await wait(retryWaitSeconds);
+  debug(`Waited ${Date.now() - waitStart}ms`);
+  debug(`Configured wait: ${retryWaitSeconds}ms`);
+}

test-data/large-output/Makefile

@@ -0,0 +1,13 @@
+SHELL = bash
+
+# this tests fix for the following issues
+# https://github.com/nick-fields/retry/issues/76
+# https://github.com/nick-fields/retry/issues/84
+
+bytes-%:
+	for i in {1..$*}; do cat kibibyte.txt; done; exit 2
+.PHONY: bytes-%
+
+lines-%:
+	for i in {1..$*}; do echo a; done; exit 2
+.PHONY: lines-%

test-data/large-output/kibibyte.txt

@@ -0,0 +1,13 @@
+1: 0000 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+2: 0081 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+3: 0162 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+4:  243 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+5:  324 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+6:  405 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+7:  486 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+8:  567 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+9:  648 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+a:  729 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+b:  810 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+c:  891 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+d:  972 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa