Skip to content

Add an example that helps use custom commands as "shell" #2647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
skedwards88 merged 5 commits into from
Jan 25, 2021
Merged

Add an example that helps use custom commands as "shell" #2647

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fcb9122
Add an example that helps use custom command
JJ Jan 7, 2021
19082c2
Update to follow guidelines closer
JJ Jan 7, 2021
8694417
Accept suggestion :+1:
JJ Jan 23, 2021
33eee7f
Accept this :+1:
JJ Jan 23, 2021
86979b5
Merge branch 'main' into patch-1
Jan 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions content/actions/reference/workflow-syntax-for-github-actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -701,6 +701,18 @@ steps:

You can set the `shell` value to a template string using `command […options] {0} [..more_options]`. {% data variables.product.prodname_dotcom %} interprets the first whitespace-delimited word of the string as the command, and inserts the file name for the temporary script at `{0}`.

For example:

```yaml
steps:
- name: Display the environment variables and their values
run: |
print %ENV
shell: perl {0}
```

The command used, `perl` in this example, must be installed on the runner. For information about the software included on GitHub-hosted runners, see "[Specifications for GitHub-hosted runners](/actions/reference/specifications-for-github-hosted-runners#supported-software)."

#### Exit codes and error action preference

For built-in shell keywords, we provide the following defaults that are executed by {% data variables.product.prodname_dotcom %}-hosted runners. You should use these guidelines when running shell scripts.
Expand Down