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

Commit

Permalink
Merge branch 'master' into v2
Browse files Browse the repository at this point in the history
  • Loading branch information
youyo committed Dec 17, 2022
2 parents e28c6a2 + 16aeedf commit 47fc1ac
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AWS-CDK GitHub Actions

AWS-CDK GitHub Actions allow you to run `cdk deploy` and `cdk diff` and ... on your pull requests to help you review.
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.

## Supported language

Expand Down Expand Up @@ -53,9 +53,10 @@ jobs:
AWS_DEFAULT_REGION: 'ap-northeast-1'
```
### Can I take a assume-role?
### Can I use assume-role?
If you use assume-role, we recommend using [awscredswrap](https://github.com/marketplace/actions/aws-assume-role-github-actions).
If you use assume-role, we recommended using awscredswrap!
See: https://github.com/marketplace/actions/aws-assume-role-github-actions#use-as-github-actions
```yaml
Expand Down Expand Up @@ -84,7 +85,7 @@ jobs:
## Inputs
- `cdk_subcommand` **Required** AWS CDK subcommand to execute.
- `cdk_subcommand` **Required** AWS CDK subcommand to execute ('deploy', 'diff', etc.)
- `cdk_version` AWS CDK version to install. (default: 'latest')
- `cdk_stack` AWS CDK stack name to execute. (default: '*')
- `working_dir` AWS CDK working directory. (default: '.')
Expand All @@ -101,7 +102,7 @@ jobs:
- `AWS_SECRET_ACCESS_KEY` **Required**
- `GITHUB_TOKEN` Required for `actions_comment=true`

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`.
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`.

## License

Expand Down

0 comments on commit 47fc1ac

Please sign in to comment.