Skip to content

Commit 1c06a50

Browse files
JJskedwards88
andauthored
Add an example that helps use custom commands as "shell" (#2647)
Co-authored-by: Sarah Edwards <[email protected]>
1 parent 1c180b3 commit 1c06a50

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

content/actions/reference/workflow-syntax-for-github-actions.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -701,6 +701,18 @@ steps:
701701

702702
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}`.
703703

704+
For example:
705+
706+
```yaml
707+
steps:
708+
- name: Display the environment variables and their values
709+
run: |
710+
print %ENV
711+
shell: perl {0}
712+
```
713+
714+
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)."
715+
704716
#### Exit codes and error action preference
705717

706718
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.

0 commit comments

Comments
 (0)