Merge pull request #48 from nick-invision/nrf/continue-on-error

Add continue_on_error action input

.github/workflows/ci_cd.yml

@@ -60,6 +60,26 @@ jobs:
           actual: ${{ steps.sad_path_wait_sec.outputs.exit_error }}
           comparison: contains
 
+      - 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')"
+
       - name: sad-path (error)
         id: sad_path_error
         uses: ./
@@ -77,6 +97,41 @@ jobs:
           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: ./
@@ -121,7 +176,6 @@ jobs:
           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
@@ -197,6 +251,76 @@ jobs:
           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_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
+      - 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:
     name: Publish Action

.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

@@ -6,7 +6,11 @@ Retries an Action step on failure or timeout. This is currently intended to repl
 
 ### `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 +24,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 +36,18 @@ 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.
+
+### `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`
+
 ## Outputs
 
 ### `total_attempts`
@@ -44,6 +64,17 @@ The final error returned by the command
 
 ## Examples
 
+### Shell
+
+```yaml
+uses: nick-invision/retry@v2
+with:
+  timeout_minutes: 10
+  max_attempts: 3
+  shell: pwsh
+  command: dir
+```
+
 ### Timeout in minutes
 
 ```yaml
@@ -86,7 +117,29 @@ 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
+  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-invision/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
+  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-invision/retry@v2
@@ -115,6 +168,44 @@ with:
     actual: ${{ steps.retry.outputs.total_attempts }}
 ```
 
+### Run script after failure but before retry
+
+```yaml
+uses: nick-invision/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 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.

action.yml

@@ -18,12 +18,24 @@ 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
 outputs:
   total_attempts:
     description: The final number of attempts made

dist/index.js

@@ -51,6 +51,7 @@ module.exports =
 // We use any as a valid input type
 /* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.toCommandProperties = exports.toCommandValue = void 0;
 /**
  * Sanitizes an input into a string so it can be passed into issueCommand safely
  * @param input input to sanitize into a string
@@ -65,6 +66,25 @@ function toCommandValue(input) {
     return JSON.stringify(input);
 }
 exports.toCommandValue = toCommandValue;
+/**
+ *
+ * @param annotationProperties
+ * @returns The command properties to send with the actual annotation command
+ * See IssueCommandProperties: https://github.com/actions/runner/blob/main/src/Runner.Worker/ActionCommandManager.cs#L646
+ */
+function toCommandProperties(annotationProperties) {
+    if (!Object.keys(annotationProperties).length) {
+        return {};
+    }
+    return {
+        title: annotationProperties.title,
+        line: annotationProperties.startLine,
+        endLine: annotationProperties.endLine,
+        col: annotationProperties.startColumn,
+        endColumn: annotationProperties.endColumn
+    };
+}
+exports.toCommandProperties = toCommandProperties;
 //# sourceMappingURL=utils.js.map
 
 /***/ }),
@@ -82,14 +102,27 @@ module.exports = require("os");
 "use strict";
 
 // For internal use, subject to change.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.issueCommand = void 0;
 // We use any as a valid input type
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const fs = __importStar(__webpack_require__(747));
@@ -249,8 +282,13 @@ var TIMEOUT_SECONDS = getInputNumber('timeout_seconds', false);
 var MAX_ATTEMPTS = getInputNumber('max_attempts', true) || 3;
 var COMMAND = core_1.getInput('command', { required: true });
 var RETRY_WAIT_SECONDS = getInputNumber('retry_wait_seconds', false) || 10;
+var SHELL = core_1.getInput('shell');
 var POLLING_INTERVAL_SECONDS = getInputNumber('polling_interval_seconds', false) || 1;
 var RETRY_ON = core_1.getInput('retry_on') || 'any';
+var WARNING_ON_RETRY = core_1.getInput('warning_on_retry').toLowerCase() === 'true';
+var ON_RETRY_COMMAND = core_1.getInput('on_retry_command');
+var CONTINUE_ON_ERROR = getInputBoolean('continue_on_error');
+var OS = process.platform;
 var OUTPUT_TOTAL_ATTEMPTS_KEY = 'total_attempts';
 var OUTPUT_EXIT_CODE_KEY = 'exit_code';
 var OUTPUT_EXIT_ERROR_KEY = 'exit_error';
@@ -268,6 +306,13 @@ function getInputNumber(id, required) {
     }
     return num;
 }
+function getInputBoolean(id) {
+    var input = core_1.getInput(id);
+    if (!['true', 'false'].includes(input.toLowerCase())) {
+        throw "Input " + id + " only accepts boolean values.  Received " + input;
+    }
+    return input.toLowerCase() === 'true';
+}
 function retryWait() {
     return __awaiter(this, void 0, void 0, function () {
         var waitStart;
@@ -291,9 +336,6 @@ 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");
-            }
             return [2 /*return*/];
         });
     });
@@ -307,17 +349,78 @@ function getTimeout() {
     }
     throw new Error('Must specify either timeout_minutes or timeout_seconds inputs');
 }
+function getExecutable() {
+    if (!SHELL) {
+        return OS === 'win32' ? 'powershell' : 'bash';
+    }
+    var executable;
+    switch (SHELL) {
+        case "bash":
+        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;
+}
+function runRetryCmd() {
+    return __awaiter(this, void 0, void 0, function () {
+        var error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    // if no retry script, just continue
+                    if (!ON_RETRY_COMMAND) {
+                        return [2 /*return*/];
+                    }
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, child_process_1.execSync(ON_RETRY_COMMAND, { stdio: 'inherit' })];
+                case 2:
+                    _a.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    error_1 = _a.sent();
+                    core_1.info("WARNING: Retry command threw the error " + error_1.message);
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/];
+            }
+        });
+    });
+}
 function runCmd() {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function () {
-        var end_time, child;
+        var end_time, executable, child;
         return __generator(this, function (_c) {
             switch (_c.label) {
                 case 0:
                     end_time = Date.now() + getTimeout();
+                    executable = getExecutable();
                     exit = 0;
                     done = false;
-                    child = child_process_1.exec(COMMAND);
+                    core_1.debug("Running command " + COMMAND + " on " + OS + " using shell " + executable);
+                    child = child_process_1.exec(COMMAND, { 'shell': executable });
                     (_a = child.stdout) === null || _a === void 0 ? void 0 : _a.on('data', function (data) {
                         process.stdout.write(data);
                     });
@@ -364,7 +467,7 @@ function runCmd() {
 }
 function runAction() {
     return __awaiter(this, void 0, void 0, function () {
-        var attempt, error_1;
+        var attempt, error_2;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, validateInputs()];
@@ -373,38 +476,44 @@ function runAction() {
                     attempt = 1;
                     _a.label = 2;
                 case 2:
-                    if (!(attempt <= MAX_ATTEMPTS)) return [3 /*break*/, 7];
+                    if (!(attempt <= MAX_ATTEMPTS)) return [3 /*break*/, 12];
                     _a.label = 3;
                 case 3:
-                    _a.trys.push([3, 5, , 6]);
+                    _a.trys.push([3, 5, , 11]);
                     // just keep overwriting attempts output
                     core_1.setOutput(OUTPUT_TOTAL_ATTEMPTS_KEY, attempt);
                     return [4 /*yield*/, runCmd()];
                 case 4:
                     _a.sent();
                     core_1.info("Command completed after " + attempt + " attempt(s).");
-                    return [3 /*break*/, 7];
+                    return [3 /*break*/, 12];
                 case 5:
-                    error_1 = _a.sent();
-                    if (attempt === MAX_ATTEMPTS) {
-                        throw new Error("Final attempt failed. " + error_1.message);
-                    }
-                    else if (!done && RETRY_ON === 'error') {
-                        // error: timeout
-                        throw error_1;
-                    }
-                    else if (exit > 0 && RETRY_ON === 'timeout') {
-                        // error: error
-                        throw error_1;
+                    error_2 = _a.sent();
+                    if (!(attempt === MAX_ATTEMPTS)) return [3 /*break*/, 6];
+                    throw new Error("Final attempt failed. " + error_2.message);
+                case 6:
+                    if (!(!done && RETRY_ON === 'error')) return [3 /*break*/, 7];
+                    // error: timeout
+                    throw error_2;
+                case 7:
+                    if (!(exit > 0 && RETRY_ON === 'timeout')) return [3 /*break*/, 8];
+                    // error: error
+                    throw error_2;
+                case 8: return [4 /*yield*/, runRetryCmd()];
+                case 9:
+                    _a.sent();
+                    if (WARNING_ON_RETRY) {
+                        core_1.warning("Attempt " + attempt + " failed. Reason: " + error_2.message);
                     }
                     else {
-                        core_1.warning("Attempt " + attempt + " failed. Reason: " + error_1.message);
+                        core_1.info("Attempt " + attempt + " failed. Reason: " + error_2.message);
                     }
-                    return [3 /*break*/, 6];
-                case 6:
+                    _a.label = 10;
+                case 10: return [3 /*break*/, 11];
+                case 11:
                     attempt++;
                     return [3 /*break*/, 2];
-                case 7: return [2 /*return*/];
+                case 12: return [2 /*return*/];
             }
         });
     });
@@ -415,12 +524,20 @@ runAction()
     process.exit(0); // success
 })
     .catch(function (err) {
-    core_1.error(err.message);
+    // exact error code if available, otherwise just 1
+    var exitCode = exit > 0 ? exit : 1;
+    if (CONTINUE_ON_ERROR) {
+        core_1.warning(err.message);
+    }
+    else {
+        core_1.error(err.message);
+    }
     // these can be  helpful to know if continue-on-error is true
     core_1.setOutput(OUTPUT_EXIT_ERROR_KEY, err.message);
-    core_1.setOutput(OUTPUT_EXIT_CODE_KEY, exit > 0 ? exit : 1);
-    // exit with exact error code if available, otherwise just exit with 1
-    process.exit(exit > 0 ? exit : 1);
+    core_1.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);
 });
 
 
@@ -431,14 +548,27 @@ runAction()
 
 "use strict";
 
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.issue = exports.issueCommand = void 0;
 const os = __importStar(__webpack_require__(87));
 const utils_1 = __webpack_require__(82);
 /**
@@ -517,6 +647,25 @@ function escapeProperty(s) {
 
 "use strict";
 
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -526,14 +675,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getState = exports.saveState = exports.group = exports.endGroup = exports.startGroup = exports.info = exports.notice = exports.warning = exports.error = exports.debug = exports.isDebug = exports.setFailed = exports.setCommandEcho = exports.setOutput = exports.getBooleanInput = exports.getMultilineInput = exports.getInput = exports.addPath = exports.setSecret = exports.exportVariable = exports.ExitCode = void 0;
 const command_1 = __webpack_require__(431);
 const file_command_1 = __webpack_require__(102);
 const utils_1 = __webpack_require__(82);
@@ -600,7 +743,9 @@ function addPath(inputPath) {
 }
 exports.addPath = addPath;
 /**
- * Gets the value of an input.  The value is also trimmed.
+ * Gets the value of an input.
+ * Unless trimWhitespace is set to false in InputOptions, the value is also trimmed.
+ * Returns an empty string if the value is not defined.
  *
  * @param     name     name of the input to get
  * @param     options  optional. See InputOptions.
@@ -611,9 +756,49 @@ function getInput(name, options) {
     if (options && options.required && !val) {
         throw new Error(`Input required and not supplied: ${name}`);
     }
+    if (options && options.trimWhitespace === false) {
+        return val;
+    }
     return val.trim();
 }
 exports.getInput = getInput;
+/**
+ * Gets the values of an multiline input.  Each value is also trimmed.
+ *
+ * @param     name     name of the input to get
+ * @param     options  optional. See InputOptions.
+ * @returns   string[]
+ *
+ */
+function getMultilineInput(name, options) {
+    const inputs = getInput(name, options)
+        .split('\n')
+        .filter(x => x !== '');
+    return inputs;
+}
+exports.getMultilineInput = getMultilineInput;
+/**
+ * Gets the input value of the boolean type in the YAML 1.2 "core schema" specification.
+ * Support boolean input list: `true | True | TRUE | false | False | FALSE` .
+ * The return value is also in boolean type.
+ * ref: https://yaml.org/spec/1.2/spec.html#id2804923
+ *
+ * @param     name     name of the input to get
+ * @param     options  optional. See InputOptions.
+ * @returns   boolean
+ */
+function getBooleanInput(name, options) {
+    const trueValue = ['true', 'True', 'TRUE'];
+    const falseValue = ['false', 'False', 'FALSE'];
+    const val = getInput(name, options);
+    if (trueValue.includes(val))
+        return true;
+    if (falseValue.includes(val))
+        return false;
+    throw new TypeError(`Input does not meet YAML 1.2 "Core Schema" specification: ${name}\n` +
+        `Support boolean input list: \`true | True | TRUE | false | False | FALSE\``);
+}
+exports.getBooleanInput = getBooleanInput;
 /**
  * Sets the value of an output.
  *
@@ -622,6 +807,7 @@ exports.getInput = getInput;
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function setOutput(name, value) {
+    process.stdout.write(os.EOL);
     command_1.issueCommand('set-output', { name }, value);
 }
 exports.setOutput = setOutput;
@@ -668,19 +854,30 @@ exports.debug = debug;
 /**
  * Adds an error issue
  * @param message error issue message. Errors will be converted to string via toString()
+ * @param properties optional properties to add to the annotation.
  */
-function error(message) {
-    command_1.issue('error', message instanceof Error ? message.toString() : message);
+function error(message, properties = {}) {
+    command_1.issueCommand('error', utils_1.toCommandProperties(properties), message instanceof Error ? message.toString() : message);
 }
 exports.error = error;
 /**
- * Adds an warning issue
+ * Adds a warning issue
  * @param message warning issue message. Errors will be converted to string via toString()
+ * @param properties optional properties to add to the annotation.
  */
-function warning(message) {
-    command_1.issue('warning', message instanceof Error ? message.toString() : message);
+function warning(message, properties = {}) {
+    command_1.issueCommand('warning', utils_1.toCommandProperties(properties), message instanceof Error ? message.toString() : message);
 }
 exports.warning = warning;
+/**
+ * Adds a notice issue
+ * @param message notice issue message. Errors will be converted to string via toString()
+ * @param properties optional properties to add to the annotation.
+ */
+function notice(message, properties = {}) {
+    command_1.issueCommand('notice', utils_1.toCommandProperties(properties), message instanceof Error ? message.toString() : message);
+}
+exports.notice = notice;
 /**
  * Writes info to log with console.log.
  * @param message info message

package.json

@@ -18,7 +18,7 @@
   },
   "homepage": "https://github.com/nick-invision/retry#readme",
   "dependencies": {
-    "@actions/core": "^1.2.6",
+    "@actions/core": "^1.5.0",
     "milliseconds": "^1.0.3",
     "tree-kill": "^1.2.2"
   },
@@ -32,7 +32,7 @@
     "@zeit/ncc": "^0.20.5",
     "dotenv": "8.2.0",
     "husky": "4.3.0",
-    "semantic-release": "17.2.2",
+    "semantic-release": "17.2.3",
     "ts-node": "9.0.0",
     "typescript": "4.0.5"
   },

sample.env

@@ -2,5 +2,6 @@ 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/index.ts

@@ -1,5 +1,5 @@
 import { getInput, error, warning, info, debug, setOutput } from '@actions/core';
-import { exec } from 'child_process';
+import { exec, execSync } from 'child_process';
 import ms from 'milliseconds';
 import kill from 'tree-kill';
 
@@ -11,9 +11,14 @@ 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 OS = process.platform;
 const OUTPUT_TOTAL_ATTEMPTS_KEY = 'total_attempts';
 const OUTPUT_EXIT_CODE_KEY = 'exit_code';
 const OUTPUT_EXIT_ERROR_KEY = 'exit_error';
@@ -37,6 +42,15 @@ function getInputNumber(id: string, required: boolean): number | undefined {
   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));
@@ -48,12 +62,6 @@ 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`
-    );
-  }
 }
 
 function getTimeout(): number {
@@ -66,13 +74,63 @@ function getTimeout(): number {
   throw new Error('Must specify either timeout_minutes or timeout_seconds inputs');
 }
 
+function getExecutable(): string {
+  if (!SHELL) {
+    return OS === 'win32' ? 'powershell' : 'bash';
+  }
+
+  let executable: string;
+  switch (SHELL) {
+    case "bash":
+    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() {
   const end_time = Date.now() + getTimeout();
+  const executable = getExecutable();
 
   exit = 0;
   done = false;
 
-  var child = exec(COMMAND);
+  debug(`Running command ${COMMAND} on ${OS} using shell ${executable}`)
+  var child = exec(COMMAND, { 'shell': executable });
 
   child.stdout?.on('data', (data) => {
     process.stdout.write(data);
@@ -130,7 +188,12 @@ async function runAction() {
         // error: error
         throw error;
       } else {
-        warning(`Attempt ${attempt} failed. Reason: ${error.message}`);
+        await runRetryCmd();
+        if (WARNING_ON_RETRY) {
+          warning(`Attempt ${attempt} failed. Reason: ${error.message}`);
+        } else {
+          info(`Attempt ${attempt} failed. Reason: ${error.message}`);
+        }
       }
     }
   }
@@ -142,12 +205,20 @@ runAction()
     process.exit(0); // success
   })
   .catch((err) => {
-    error(err.message);
+    // 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, 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(CONTINUE_ON_ERROR ? 0 : exitCode);
   });