patch: remove original multiline tests from ci workflow

Bumps [npm](https://github.com/npm/cli) from 8.7.0 to 8.12.2.
- [Release notes](https://github.com/npm/cli/releases)
- [Changelog](https://github.com/npm/cli/blob/latest/CHANGELOG.md)
- [Commits](https://github.com/npm/cli/compare/v8.7.0...v8.12.2)

---
updated-dependencies:
- dependency-name: npm
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Nick Fields <46869826+nick-fields@users.noreply.github.com>

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: nick-invision
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is, **including the snippet from your workflow `yaml` showing your configuration and command being executed.**
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Logs**
+Enable [debug logging](https://docs.github.com/en/free-pro-team@latest/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging) then attach the [raw logs](https://docs.github.com/en/free-pro-team@latest/actions/managing-workflow-runs/using-workflow-run-logs#downloading-logs) (specifically the raw output of this action).

.github/scripts/log-examples.js

@@ -0,0 +1,5 @@
+console.log('console.log test');
+console.warn('console.warn test');
+console.error('console.error test');
+process.stdout.write('stdout test');
+process.stderr.write('stderr test');

.github/workflows/ci_cd.yml

@@ -1,8 +1,7 @@
 name: CI/CD
 on:
   push:
-    branches:
-      - '**'
+
 jobs:
   # runs on branch pushes only
   ci:
@@ -15,16 +14,30 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 16
       - name: Install dependencies
         run: npm ci
+
       - name: happy-path
+        id: happy_path
         uses: ./
         with:
           timeout_minutes: 1
           max_attempts: 2
           command: npm -v
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: true
+          actual: ${{ steps.happy_path.outputs.total_attempts == '1' && steps.happy_path.outputs.exit_code == '0' }}
+
+      - name: log examples
+        uses: ./
+        with:
+          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:
@@ -32,20 +45,433 @@ jobs:
           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: 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: 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: ./
+        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')"
+
       - name: sad-path (error)
+        id: sad_path_error
         uses: ./
         continue-on-error: true
         with:
           timeout_minutes: 1
           max_attempts: 2
           command: node -e "process.exit(1)"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.sad_path_error.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.sad_path_error.outcome }}
+
+      - 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 }}
+
+      - name: retry_on (timeout) fails early if error encountered
+        id: retry_on_timeout_fail
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_minutes: 1
+          max_attempts: 3
+          retry_on: timeout
+          command: node -e "process.exit(2)"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 1
+          actual: ${{ steps.retry_on_timeout_fail.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.retry_on_timeout_fail.outcome }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.retry_on_timeout_fail.outputs.exit_code }}
+
+      - name: retry_on (error)
+        id: retry_on_error
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_minutes: 1
+          max_attempts: 2
+          retry_on: error
+          command: node -e "process.exit(2)"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.retry_on_error.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.retry_on_error.outcome }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.retry_on_error.outputs.exit_code }}
+
+        # timeout tests (takes longer to run so run last)
       - name: sad-path (timeout)
+        id: sad_path_timeout
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_seconds: 15
+          max_attempts: 2
+          command: node -e "(async()=>await new Promise(r => setTimeout(r, 120000)))()"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.sad_path_timeout.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.sad_path_timeout.outcome }}
+
+      - name: retry_on (timeout)
+        id: retry_on_timeout
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_seconds: 15
+          max_attempts: 2
+          retry_on: timeout
+          command: node -e "(async()=>await new Promise(r => setTimeout(r, 120000)))()"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.retry_on_timeout.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.retry_on_timeout.outcome }}
+
+      - name: retry_on (error) fails early if timeout encountered
+        id: retry_on_error_fail
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_seconds: 15
+          max_attempts: 2
+          retry_on: error
+          command: node -e "(async()=>await new Promise(r => setTimeout(r, 120000)))()"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 1
+          actual: ${{ steps.retry_on_error_fail.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.retry_on_error_fail.outcome }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 1
+          actual: ${{ steps.retry_on_error_fail.outputs.exit_code }}
+
+      - name: sad-path (timeout minutes)
+        id: sad_path_timeout_minutes
         uses: ./
         continue-on-error: true
         with:
           timeout_minutes: 1
           max_attempts: 2
           command: node -e "(async()=>await new Promise(r => setTimeout(r, 120000)))()"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.sad_path_timeout.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.sad_path_timeout.outcome }}
+
+      - 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_multiline_tests:
+    name: Run Tests (Multiline)
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-18.04
+    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: Multi-line 2 commands non existent first command
+        id: multi_line_2_commands_non_existent_first_command
+        uses: ./
+        continue-on-error: true
+        with:
+          shell: bash
+          timeout_seconds: 1
+          max_attempts: 2
+          command: |
+            i-do-not-exist && \
+            echo "i-exist"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.multi_line_2_commands_non_existent_first_command.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 'Final attempt failed'
+          actual: ${{ steps.multi_line_2_commands_non_existent_first_command.outputs.exit_error }}
+          comparison: contains
+      - uses: nick-invision/assert-action@v1
+        with:
+          # The 127 error code indicates “command not found”.
+          expected: '127'
+          actual: ${{ steps.multi_line_2_commands_non_existent_first_command.outputs.exit_code }}
+          comparison: contains
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 'i-exist'
+          actual: ${{ steps.multi_line_2_commands_non_existent_first_command.outputs.exit_error }}
+          comparison: notContains
+
+      - name: Multi-line 2 commands happy path test
+        id: multi_line_2_commands_happy_path
+        uses: ./
+        with:
+          shell: bash
+          timeout_seconds: 1
+          max_attempts: 2
+          command: |
+            echo "foo" && \
+            echo "bar"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 1
+          actual: ${{ steps.multi_line_2_commands_happy_path.outputs.total_attempts }}
+
+      - name: Conventional multi-line non existent first command
+        id: conventional_multi_line_non_existent_first_command
+        uses: ./
+        continue-on-error: true
+        with:
+          shell: bash
+          timeout_seconds: 1
+          max_attempts: 2
+          command: |
+            i-do-not-exist
+            echo "i-exist"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.conventional_multi_line_non_existent_first_command.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 'Final attempt failed'
+          actual: ${{ steps.conventional_multi_line_non_existent_first_command.outputs.exit_error }}
+          comparison: contains
+      - uses: nick-invision/assert-action@v1
+        with:
+          # The 127 error code indicates “command not found”.
+          expected: '127'
+          actual: ${{ steps.conventional_multi_line_non_existent_first_command.outputs.exit_code }}
+          comparison: contains
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 'i-exist'
+          actual: ${{ steps.conventional_multi_line_non_existent_first_command.outputs.exit_error }}
+          comparison: notContains
+
+      - name: Conventional multi-line happy path test
+        id: conventional_multi_line_happy_path
+        uses: ./
+        with:
+          shell: bash
+          timeout_seconds: 1
+          max_attempts: 2
+          command: |
+            echo "foo"
+            echo "bar"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 1
+          actual: ${{ steps.conventional_multi_line_happy_path.outputs.total_attempts }}
+
+  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: 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"
 
   # runs on push to master only
   cd:
@@ -59,7 +485,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

.nvmrc

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

.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 },
         ],
       },

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,16 +28,215 @@ 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`
 
-## Example usage
+### `retry_on`
+
+**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`
+
+The final number of attempts made
+
+### `exit_code`
+
+The final exit code returned by the command
+
+### `exit_error`
+
+The final error returned by the command
+
+## Examples
+
+### Shell
 
 ```yaml
-uses: nick-invision/retry@v1
+uses: nick-fields/retry@v2
 with:
   timeout_minutes: 10
   max_attempts: 3
-  command: npm install
+  shell: pwsh
+  command: dir
 ```
+
+### Timeout in minutes
+
+```yaml
+uses: nick-fields/retry@v2
+with:
+  timeout_minutes: 10
+  max_attempts: 3
+  command: npm run some-typically-slow-script
+```
+
+### Timeout in seconds
+
+```yaml
+uses: nick-fields/retry@v2
+with:
+  timeout_seconds: 15
+  max_attempts: 3
+  command: npm run some-typically-fast-script
+```
+
+### Only retry after timeout
+
+```yaml
+uses: nick-fields/retry@v2
+with:
+  timeout_seconds: 15
+  max_attempts: 3
+  retry_on: timeout
+  command: npm run some-typically-fast-script
+```
+
+### Only retry after error
+
+```yaml
+uses: nick-fields/retry@v2
+with:
+  timeout_seconds: 15
+  max_attempts: 3
+  retry_on: error
+  command: npm run some-typically-fast-script
+```
+
+### Retry using continue_on_error input (in composite action) but allow failure and do something with output
+
+```yaml
+- 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
+  with:
+    timeout_seconds: 15
+    max_attempts: 3
+    retry_on: error
+    command: node -e 'process.exit(99);'
+- name: Assert that action failed
+  uses: nick-fields/assert-action@v1
+  with:
+    expected: failure
+    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 }}
+- name: Assert that action made expected number of attempts
+  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

@@ -2,8 +2,11 @@ name: Retry Step
 description: 'Retry a step on failure or timeout'
 inputs:
   timeout_minutes:
-    description: Minutes to wait before attempt times out
-    required: true
+    description: Minutes to wait before attempt times out.  Must only specify either minutes or seconds
+    required: false
+  timeout_seconds:
+    description: Seconds to wait before attempt times out.  Must only specify either minutes or seconds
+    required: false
   max_attempts:
     description: Number of attempts to make before failing the step
     required: true
@@ -15,10 +18,37 @@ 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
+  exit_code:
+    description: The final exit code returned by the command
+  exit_error:
+    description: The final error returned by the command
 runs:
   using: 'node12'
-  main: 'dist/index.js'
+  main: 'dist/index.js'

dist/exec.js

@@ -1,8 +0,0 @@
-const { execSync } = require('child_process');
-const COMMAND = process.argv.splice(2)[0];
-
-function run() {
-  execSync(COMMAND, { stdio: 'inherit' });
-}
-
-run();

package.json

@@ -3,32 +3,38 @@
   "version": "0.0.0-managed-by-semantic-release",
   "description": "Retries a GitHub Action step on failure or timeout.",
   "scripts": {
-    "prepare": "ncc build src/index.js"
+    "local": "npm run prepare && node -r dotenv/config ./dist/index.js",
+    "prepare": "ncc build src/index.ts"
   },
   "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.4",
+    "@actions/core": "^1.8.2",
     "milliseconds": "^1.0.3",
     "tree-kill": "^1.2.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^8.3.5",
-    "@commitlint/config-conventional": "^8.3.4",
-    "@semantic-release/changelog": "^3.0.6",
-    "@semantic-release/git": "^7.0.18",
+    "@commitlint/cli": "^16.2.3",
+    "@commitlint/config-conventional": "^16.2.1",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@types/milliseconds": "0.0.30",
+    "@types/node": "14.14.7",
     "@zeit/ncc": "^0.20.5",
-    "husky": "^3.1.0",
-    "semantic-release": "^17.0.3"
+    "dotenv": "8.2.0",
+    "husky": "^4.3.8",
+    "semantic-release": "19.0.3",
+    "ts-node": "9.0.0",
+    "typescript": "4.0.5"
   },
   "husky": {
     "hooks": {

sample.env

@@ -0,0 +1,7 @@
+INPUT_TIMEOUT_MINUTES=1
+INPUT_MAX_ATTEMPTS=3
+INPUT_COMMAND="node -e 'process.exit(99)'"
+INPUT_RETRY_WAIT_SECONDS=10
+SHELL=pwsh
+INPUT_POLLING_INTERVAL_SECONDS=1
+INPUT_RETRY_ON=any

src/exec.js

@@ -1,8 +0,0 @@
-const { execSync } = require('child_process');
-const COMMAND = process.argv.splice(2)[0];
-
-function run() {
-  execSync(COMMAND, { stdio: 'inherit' });
-}
-
-run();

src/index.js

@@ -1,84 +0,0 @@
-const { getInput, error, warning, info, debug } = require('@actions/core');
-const { spawn } = require('child_process');
-const { join } = require('path');
-const ms = require('milliseconds');
-var kill = require('tree-kill');
-
-function getInputNumber(id, required) {
-  const input = getInput(id, { required });
-  const num = Number.parseInt(input);
-
-  if (!Number.isInteger(num)) {
-    throw `Input ${id} only accepts numbers.  Received ${input}`;
-  }
-
-  return num;
-}
-
-// inputs
-const TIMEOUT_MINUTES = getInputNumber('timeout_minutes', true);
-const MAX_ATTEMPTS = getInputNumber('max_attempts', true);
-const COMMAND = getInput('command', { required: true });
-const RETRY_WAIT_SECONDS = getInputNumber('retry_wait_seconds', false);
-const POLLING_INTERVAL_SECONDS = getInputNumber('polling_interval_seconds', false);
-
-async function wait(ms) {
-  return new Promise((r) => setTimeout(r, ms));
-}
-
-async function runCmd() {
-  const end_time = Date.now() + ms.minutes(TIMEOUT_MINUTES);
-  var done, exit;
-
-  var child = spawn('node', [join(__dirname, 'exec.js'), COMMAND], { stdio: 'inherit' });
-
-  child.on('exit', (code) => {
-    if (code > 0) {
-      exit = code;
-    }
-    done = true;
-  });
-
-  do {
-    await wait(ms.seconds(POLLING_INTERVAL_SECONDS));
-  } while (Date.now() < end_time && !done && !exit);
-
-  if (!done) {
-    kill(child.pid);
-    await retryWait();
-    throw new Error(`Timeout of ${TIMEOUT_MINUTES}m hit`);
-  } else if (exit > 0) {
-    await retryWait();
-    throw new Error(`Child_process exited with error`);
-  } else {
-    return;
-  }
-}
-
-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 runAction() {
-  for (let attempt = 1; attempt <= MAX_ATTEMPTS; attempt++) {
-    try {
-      await runCmd();
-      info(`Command completed after ${attempt} attempt(s).`);
-      break;
-    } catch (error) {
-      if (attempt === MAX_ATTEMPTS) {
-        throw new Error(`Final attempt failed. ${error.message}`);
-      } else {
-        warning(`Attempt ${attempt} failed. Reason:`, error.message);
-      }
-    }
-  }
-}
-
-runAction().catch((err) => {
-  error(err.message);
-  process.exit(1);
-});

src/index.ts

@@ -0,0 +1,234 @@
+import { getInput, error, warning, info, debug, setOutput } from '@actions/core';
+import { exec, execSync } 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 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);
+
+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;
+
+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;
+}
+
+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'
+}
+
+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');
+  }
+}
+
+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');
+}
+
+function getExecutable(): string {
+  if (!SHELL) {
+    return OS === 'win32' ? 'powershell' : 'bash -e';
+  }
+
+  let executable: string;
+  switch (SHELL) {
+    case "bash": {
+      // -e to not ignore errors, but exit with non-zero code.
+      executable = "bash -e";
+      break;
+    }
+    case "python":
+    case "pwsh": {
+      executable = SHELL;
+      break;
+    }
+    case "sh": {
+      if (OS === 'win32') {
+        throw new Error(`Shell ${SHELL} not allowed on OS ${OS}`);
+      }
+      executable = SHELL;
+      break;
+    }
+    case "cmd":
+    case "powershell": {
+      if (OS !== 'win32') {
+        throw new Error(`Shell ${SHELL} not allowed on OS ${OS}`);
+      }
+      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`);
+    }
+  }
+  return executable
+}
+
+async function runRetryCmd(): Promise<void> {
+  // if no retry script, just continue
+  if (!ON_RETRY_COMMAND) {
+    return;
+  }
+
+  try {
+    await execSync(ON_RETRY_COMMAND, { stdio: 'inherit' });
+  } catch (error) {
+    info(`WARNING: Retry command threw the error ${error.message}`)
+  }
+}
+
+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}"`)
+  var 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);
+  });
+  child.stderr?.on('data', (data) => {
+    process.stdout.write(data);
+  });
+
+  child.on('exit', (code, signal) => {
+    debug(`Code: ${code}`);
+    debug(`Signal: ${signal}`);
+    if (code && code > 0) {
+      exit = code;
+    }
+    // timeouts are killed manually
+    if (signal === 'SIGTERM') {
+      return;
+    }
+    done = true;
+  });
+
+  do {
+    await wait(ms.seconds(POLLING_INTERVAL_SECONDS));
+  } while (Date.now() < end_time && !done);
+
+  if (!done) {
+    kill(child.pid);
+    await retryWait();
+    throw new Error(`Timeout of ${getTimeout()}ms hit`);
+  } else if (exit > 0) {
+    await retryWait();
+    throw new Error(`Child_process exited with error code ${exit}`);
+  } else {
+    return;
+  }
+}
+
+async function runAction() {
+  await validateInputs();
+
+  for (let attempt = 1; attempt <= MAX_ATTEMPTS; attempt++) {
+    try {
+      // just keep overwriting attempts output
+      setOutput(OUTPUT_TOTAL_ATTEMPTS_KEY, attempt);
+      await runCmd(attempt);
+      info(`Command completed after ${attempt} attempt(s).`);
+      break;
+    } catch (error) {
+      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;
+      } else {
+        await runRetryCmd();
+        if (WARNING_ON_RETRY) {
+          warning(`Attempt ${attempt} failed. Reason: ${error.message}`);
+        } else {
+          info(`Attempt ${attempt} failed. Reason: ${error.message}`);
+        }
+      }
+    }
+  }
+}
+
+runAction()
+  .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 (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, exitCode);
+
+    // 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(CONTINUE_ON_ERROR ? 0 : exitCode);
+  });

src/util.ts

@@ -0,0 +1,3 @@
+export async function wait(ms: number) {
+  return new Promise((r) => setTimeout(r, ms));
+}

tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    "noEmit": true /* Do not emit outputs. */,
+
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+
+    /* Advanced Options */
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
+  },
+  "exclude": ["**/__tests__", "**/__mocks__"]
+}