Skip to content

Commit 6c5c32e

Browse files
swintonclareliguori
authored andcommitted
Add build status, usage to README
1 parent 3b916a0 commit 6c5c32e

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,24 @@
22

33
Configure AWS credential environment variables for use in other GitHub Actions.
44

5+
<a href="https://github.com/aws/configure-aws-credentials-for-github-actions"><img alt="GitHub Actions status" src="https://github.com/aws/configure-aws-credentials-for-github-actions/workflows/test-local/badge.svg"></a>
6+
7+
This action adds configuration required by [the AWS CLI](https://aws.amazon.com/cli/) for use in subsequent actions.
8+
9+
## Usage
10+
11+
Add the following step to your workflow:
12+
13+
```yaml
14+
- name: Configure AWS Credentials
15+
uses: aws/configure-aws-credentials-for-github-actions
16+
with:
17+
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
18+
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
19+
aws-default-region: us-east-2
20+
aws-default-output: json
21+
```
22+
523
## License Summary
624
725
This code is made available under the MIT license.

0 commit comments

Comments
 (0)