Skip to content
This repository was archived by the owner on Apr 30, 2023. It is now read-only.

Commit 47fc1ac

Browse files
committed
Merge branch 'master' into v2
2 parents e28c6a2 + 16aeedf commit 47fc1ac

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AWS-CDK GitHub Actions
22

3-
AWS-CDK GitHub Actions allow you to run `cdk deploy` and `cdk diff` and ... on your pull requests to help you review.
3+
AWS-CDK GitHub Actions allow you to run `cdk deploy` and `cdk diff` (among other cdk subcommands) on your pull requests to help you review.
44

55
## Supported language
66

@@ -53,9 +53,10 @@ jobs:
5353
AWS_DEFAULT_REGION: 'ap-northeast-1'
5454
```
5555
56-
### Can I take a assume-role?
56+
### Can I use assume-role?
57+
58+
If you use assume-role, we recommend using [awscredswrap](https://github.com/marketplace/actions/aws-assume-role-github-actions).
5759
58-
If you use assume-role, we recommended using awscredswrap!
5960
See: https://github.com/marketplace/actions/aws-assume-role-github-actions#use-as-github-actions
6061
6162
```yaml
@@ -84,7 +85,7 @@ jobs:
8485
8586
## Inputs
8687
87-
- `cdk_subcommand` **Required** AWS CDK subcommand to execute.
88+
- `cdk_subcommand` **Required** AWS CDK subcommand to execute ('deploy', 'diff', etc.)
8889
- `cdk_version` AWS CDK version to install. (default: 'latest')
8990
- `cdk_stack` AWS CDK stack name to execute. (default: '*')
9091
- `working_dir` AWS CDK working directory. (default: '.')
@@ -101,7 +102,7 @@ jobs:
101102
- `AWS_SECRET_ACCESS_KEY` **Required**
102103
- `GITHUB_TOKEN` Required for `actions_comment=true`
103104

104-
Recommended to get `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` from secrets. A github token is [automatically made available](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) as a secret as `GITHUB_TOKEN`.
105+
Recommended to get `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` from secrets. The github token is [automatically made available](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) as a secret as `GITHUB_TOKEN`.
105106

106107
## License
107108

0 commit comments

Comments
 (0)