From fb3078e4c832318a77f4a868c6d796635ea02acc Mon Sep 17 00:00:00 2001
From: Henry Griffiths <42880130+henrygriffiths@users.noreply.github.com>
Date: Thu, 4 Sep 2025 18:56:03 -0500
Subject: [PATCH] chore: update readme version to v5 (#1469)
---
README.md | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index e74d4fb..5d0d4c1 100644
--- a/README.md
+++ b/README.md
@@ -180,7 +180,7 @@ this action will always consider the `HTTP_PROXY` environment variable.
Manually configured proxy:
```yaml
-uses: aws-actions/configure-aws-credentials@v4.3.1
+uses: aws-actions/configure-aws-credentials@v5.0.0
with:
aws-region: us-east-2
role-to-assume: my-github-actions-role
@@ -251,13 +251,13 @@ line.
Inline session policy examples
```yaml
- uses: aws-actions/configure-aws-credentials@v4.3.1
+ uses: aws-actions/configure-aws-credentials@v5.0.0
with:
inline-session-policy: '{"Version":"2012-10-17","Statement":[{"Sid":"Stmt1","Effect":"Allow","Action":"s3:List*","Resource":"*"}]}'
```
Or we can have a nicely formatted JSON as well:
```yaml
- uses: aws-actions/configure-aws-credentials@v4.3.1
+ uses: aws-actions/configure-aws-credentials@v5.0.0
with:
inline-session-policy: >-
{
@@ -283,13 +283,13 @@ the role.
Managed session policy examples
```yaml
- uses: aws-actions/configure-aws-credentials@v4.3.1
+ uses: aws-actions/configure-aws-credentials@v5.0.0
with:
managed-session-policies: arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess
```
And we can pass multiple managed policies likes this:
```yaml
- uses: aws-actions/configure-aws-credentials@v4.3.1
+ uses: aws-actions/configure-aws-credentials@v5.0.0
with:
managed-session-policies: |
arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess
@@ -327,7 +327,7 @@ You can specify the audience through the `audience` input:
```yaml
- name: Configure AWS Credentials for China region audience
- uses: aws-actions/configure-aws-credentials@v4.3.1
+ uses: aws-actions/configure-aws-credentials@v5.0.0
with:
audience: sts.amazonaws.com.cn
aws-region: cn-northwest-1
@@ -401,7 +401,7 @@ Examples
### AssumeRoleWithWebIdentity
```yaml
- name: Configure AWS Credentials
- uses: aws-actions/configure-aws-credentials@v4.3.1
+ uses: aws-actions/configure-aws-credentials@v5.0.0
with:
aws-region: us-east-2
role-to-assume: arn:aws:iam::123456789100:role/my-github-actions-role
@@ -415,13 +415,13 @@ environment variable and use it to assume the role
### AssumeRole with role previously assumed by action in same workflow
```yaml
- name: Configure AWS Credentials
- uses: aws-actions/configure-aws-credentials@v4.3.1
+ uses: aws-actions/configure-aws-credentials@v5.0.0
with:
aws-region: us-east-2
role-to-assume: arn:aws:iam::123456789100:role/my-github-actions-role
role-session-name: MySessionName
- name: Configure other AWS Credentials
- uses: aws-actions/configure-aws-credentials@v4.3.1
+ uses: aws-actions/configure-aws-credentials@v5.0.0
with:
aws-region: us-east-2
role-to-assume: arn:aws:iam::987654321000:role/my-second-role
@@ -436,7 +436,7 @@ role, `arn:aws:iam::987654321000:role/my-second-role`.
### AssumeRole with static IAM credentials in repository secrets
```yaml
- name: Configure AWS Credentials
- uses: aws-actions/configure-aws-credentials@v4.3.1
+ uses: aws-actions/configure-aws-credentials@v5.0.0
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -455,7 +455,7 @@ name, like `role-to-assume: my-github-actions-role`.
```yaml
- name: Configure AWS Credentials 1
id: creds
- uses: aws-actions/configure-aws-credentials@v4.3.1
+ uses: aws-actions/configure-aws-credentials@v5.0.0
with:
aws-region: us-east-2
role-to-assume: arn:aws:iam::123456789100:role/my-github-actions-role
@@ -464,7 +464,7 @@ name, like `role-to-assume: my-github-actions-role`.
run: |
aws sts get-caller-identity
- name: Configure AWS Credentials 2
- uses: aws-actions/configure-aws-credentials@v4.3.1
+ uses: aws-actions/configure-aws-credentials@v5.0.0
with:
aws-region: us-east-2
aws-access-key-id: ${{ steps.creds.outputs.aws-access-key-id }}