-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 5e4733a
Showing
1,751 changed files
with
1,071,614 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2019 Penguin | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
# AWS Secrets Manager Actions | ||
|
||
[![npm version](https://img.shields.io/npm/v/aws-secrets-manager-actions?color=cb3837&logo=npm)](https://www.npmjs.com/package/aws-secrets-manager-actions) | ||
[![GitHub Actions Test](https://github.com/say8425/aws-secrets-manager-actions/workflows/Test/badge.svg)](https://github.com/say8425/aws-secrets-manager-actions/actions?query=workflow%3ATest) | ||
[![GitHub Actions Publish](https://github.com/say8425/aws-secrets-manager-actions/workflows/Publish/badge.svg)](https://github.com/say8425/aws-secrets-manager-actions/actions?query=workflow%3APublish) | ||
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/say8425/aws-secrets-manager-actions/blob/master/LICENSE) | ||
|
||
This GitHub Action helps you use your Environment values that stored at [AWS Secrets Manager](https://aws.amazon.com/secrets-manager). | ||
|
||
## Usage | ||
|
||
```yaml | ||
steps: | ||
- name: Store ENV from AWS SecretManager | ||
uses: say8425/aws-secrets-manager-actions@v1 | ||
with: | ||
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} | ||
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} | ||
AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }} | ||
SECRET_NAME: ${{ secrets.SECRET_NAME }} | ||
``` | ||
Add your AWS IAM keys. And add you want to use secret name from your AWS Secrets Manager secrets list. | ||
Then your secrets will be environment values. | ||
### AWS IAM | ||
You need [AWS IAM](https://aws.amazon.com/iam) user that has proper policy to access AWS Secrets Manager. | ||
If you have it, then add this IAM user keys at `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and region `AWS_DEFAULT_REGION`. | ||
But we greatly recommend to store these keys at [GitHub Secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets). | ||
|
||
#### Policy | ||
|
||
```json | ||
{ | ||
"Version": "2012-10-17", | ||
"Statement": [ | ||
{ | ||
"Sid": "VisualEditor0", | ||
"Effect": "Allow", | ||
"Action": "secretsmanager:GetSecretValue", | ||
"Resource": "*" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
If you need policy example, then feel free to use this above policy. | ||
And you can get more information at [AWS User Guide](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_identity-based-policies.html#permissions_grant-get-secret-value-to-one-secret). | ||
|
||
### Secret Name | ||
|
||
Add you want to use secret name from your AWS Secrets Manager secrets list. | ||
You can use only one secret name. | ||
|
||
### Environments | ||
|
||
Your secrets will be environment values. | ||
And these environment values are masked with `***`. So never be revealed. | ||
|
||
## Contributing | ||
|
||
Your Contributions are always welcome! | ||
Feel free to check [issues](https://github.com/say8425/aws-secrets-manager-action/issues) | ||
or [Pull Requests](https://github.com/say8425/aws-secrets-manager-actions/pulls) | ||
|
||
## License | ||
|
||
This project is [MIT](https://github.com/say8425/aws-secrets-manager-action/blob/master/LICENSE) licensed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
name: 'aws-secrets-manager-actions' | ||
description: 'GitHub Actions for AWS Secrets Manager' | ||
inputs: | ||
SECRET_NAME: | ||
description: 'Set secret name that you want to get.' | ||
required: true | ||
AWS_ACCESS_KEY_ID: | ||
description: 'Set Aws Access Key ID' | ||
required: true | ||
AWS_SECRET_ACCESS_KEY: | ||
description: 'Set Aws Secret access Key' | ||
required: true | ||
AWS_DEFAULT_REGION: | ||
description: 'Set Aws default region' | ||
required: true | ||
runs: | ||
using: 'node12' | ||
main: 'dist/index.js' | ||
branding: | ||
icon: 'lock' | ||
color: 'orange' |
Large diffs are not rendered by default.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.