From e00c08a89a5b3dd353aae2f6d89c28a2d8bebab7 Mon Sep 17 00:00:00 2001 From: Dilum Aluthge Date: Tue, 4 Jun 2024 13:40:04 -0400 Subject: [PATCH] README: document that Bash is required (#132) * README: document that Bash is required * Apply suggestions from code review Co-authored-by: Curtis Vogt * Update README.md Co-authored-by: Dilum Aluthge * Replace ordered list with unordered list Co-authored-by: Curtis Vogt --------- Co-authored-by: Curtis Vogt --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0ed00a0..47794e3 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,8 @@ By default all depot directories called out below are cached. ### Requirements -This action uses [`jq`](https://github.com/jqlang/jq) to parse JSON. -`jq` is installed by default in GitHub-hosted runners. -[`dcarbone/install-jq-action`](https://github.com/dcarbone/install-jq-action) is used to check that `jq` is available and install it if not. -**Note:** installing `jq` with `dcarbone/install-jq-action` requires that curl is available; this may not be the case in custom containers. +- `jq`: This action uses [`jq`](https://github.com/jqlang/jq) to parse JSON. For GitHub-hosted runners, `jq` is installed by default. On self-hosted runners and custom containers, if `jq` is not already available, this action will automatically use [`dcarbone/install-jq-action`](https://github.com/dcarbone/install-jq-action) to install `jq` (Note: `dcarbone/install-jq-action` requires that `curl` is installed; this may not always be the case in custom containers and self-hosted runners). +- `bash`: This action requires `bash`. For GitHub-hosted runners `bash` is installed by default. Self-hosted runners will need to ensure that `bash` is installed and available on the `PATH`. ### Optional Inputs