From 3b07a5d7d64aebe6dc443d204df29ecaf322da91 Mon Sep 17 00:00:00 2001 From: allisaurus <34254888+allisaurus@users.noreply.github.com> Date: Mon, 1 Mar 2021 14:17:02 -0800 Subject: [PATCH] chore: Add note about use with aws-cli to README (#181) --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 8fdd931..a800632 100644 --- a/README.md +++ b/README.md @@ -188,6 +188,11 @@ with: ``` In this case, your runner's credentials must have permissions to assume the role. +### Use with the AWS CLI + +This workflow does _not_ install the [AWS CLI](https://aws.amazon.com/cli/) into your environment. Self-hosted runners that intend to run this action prior to executing `aws` commands need to have the AWS CLI [installed](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) if it's not already present. +Most [GitHub hosted runner environments](https://github.com/actions/virtual-environments) should include the AWS CLI by default. + ## License Summary This code is made available under the MIT license.