Merge pull request #31 from nick-invision/fix-docs

docs: cleanup docs around shell defaults and supported
This commit is contained in:
Nick Fields
2021-01-03 21:09:04 -05:00
committed by GitHub
3 changed files with 3 additions and 3 deletions

View File

@@ -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

2
dist/index.js vendored
View File

@@ -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;

View File

@@ -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