From bee86ddb779cbbaacd76afe36523b31d3806e552 Mon Sep 17 00:00:00 2001 From: Nick Fields Date: Sun, 3 Jan 2021 21:00:31 -0500 Subject: [PATCH] docs: cleanup docs around shell defaults and supported --- action.yml | 2 +- dist/index.js | 2 +- src/index.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/action.yml b/action.yml index d9978b3..622c855 100644 --- a/action.yml +++ b/action.yml @@ -19,7 +19,7 @@ inputs: required: false default: 10 shell: - description: Shell to Use to retry (Default is pwsh) + 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 diff --git a/dist/index.js b/dist/index.js index 88822fb..d21117f 100644 --- a/dist/index.js +++ b/dist/index.js @@ -335,7 +335,7 @@ function getExecutable() { break; } default: { - throw new Error("Shell " + SHELL + " required"); + 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; diff --git a/src/index.ts b/src/index.ts index d55da15..824c825 100644 --- a/src/index.ts +++ b/src/index.ts @@ -92,7 +92,7 @@ function getExecutable(): string { break; } default: { - throw new Error(`Shell ${SHELL} required`); + 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