Compare commits

..

28 Commits

Author SHA1 Message Date
Release Automation 9f7f57b093 chore(release): 1.3.5 2020-05-27 16:03:20 +00:00
dependabot-preview[bot] 09758fb6fe Merge pull request #66 from aws-actions/dependabot/npm_and_yarn/zeit/ncc-0.22.3 2020-05-26 19:17:49 +00:00
GitHub Actions 38878c03af chore: Update dist 2020-05-26 19:12:44 +00:00
dependabot-preview[bot] ab6dfc4459 chore: Bump @zeit/ncc from 0.22.2 to 0.22.3
Bumps [@zeit/ncc](https://github.com/zeit/ncc) from 0.22.2 to 0.22.3.
- [Release notes](https://github.com/zeit/ncc/releases)
- [Commits](https://github.com/zeit/ncc/compare/0.22.2...0.22.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-05-26 19:12:17 +00:00
dependabot-preview[bot] 9d7a893ad4 Merge pull request #68 from aws-actions/dependabot/npm_and_yarn/aws-sdk-2.684.0 2020-05-26 19:11:54 +00:00
dependabot-preview[bot] 48c7de6aec Merge pull request #67 from aws-actions/dependabot/npm_and_yarn/eslint-7.1.0 2020-05-26 19:10:37 +00:00
dependabot-preview[bot] 2371778031 chore: Bump aws-sdk from 2.679.0 to 2.684.0
Bumps [aws-sdk](https://github.com/aws/aws-sdk-js) from 2.679.0 to 2.684.0.
- [Release notes](https://github.com/aws/aws-sdk-js/releases)
- [Changelog](https://github.com/aws/aws-sdk-js/blob/master/CHANGELOG.md)
- [Commits](https://github.com/aws/aws-sdk-js/compare/v2.679.0...v2.684.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-05-26 19:10:04 +00:00
dependabot-preview[bot] aec054896e chore: Bump eslint from 7.0.0 to 7.1.0
Bumps [eslint](https://github.com/eslint/eslint) from 7.0.0 to 7.1.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/master/CHANGELOG.md)
- [Commits](https://github.com/eslint/eslint/compare/v7.0.0...v7.1.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-05-26 19:09:32 +00:00
GitHub Actions 9c93b3b896 chore: Update dist 2020-05-26 04:01:20 +00:00
Clare Liguori 0c2c1f7c12 fix: clear session token env var if present for non-session credentials (#65) 2020-05-26 04:00:51 +00:00
Release Automation 2d01f93692 chore(release): 1.3.4 2020-05-18 22:37:00 +00:00
GitHub Actions 7d7a0bc951 chore: Update dist 2020-05-18 22:12:58 +00:00
dependabot-preview[bot] 92f9ac93ef Merge pull request #62 from aws-actions/dependabot/npm_and_yarn/zeit/ncc-0.22.2 2020-05-18 22:12:15 +00:00
dependabot-preview[bot] d91230b55a chore: Bump @zeit/ncc from 0.22.0 to 0.22.2
Bumps [@zeit/ncc](https://github.com/zeit/ncc) from 0.22.0 to 0.22.2.
- [Release notes](https://github.com/zeit/ncc/releases)
- [Commits](https://github.com/zeit/ncc/compare/0.22.0...0.22.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-05-18 22:10:42 +00:00
dependabot-preview[bot] 00fabbe944 Merge pull request #60 from aws-actions/dependabot/npm_and_yarn/jest-26.0.1 2020-05-18 22:09:10 +00:00
dependabot-preview[bot] 0b4d37d15b chore: Bump jest from 25.2.4 to 26.0.1
Bumps [jest](https://github.com/facebook/jest) from 25.2.4 to 26.0.1.
- [Release notes](https://github.com/facebook/jest/releases)
- [Changelog](https://github.com/facebook/jest/blob/master/CHANGELOG.md)
- [Commits](https://github.com/facebook/jest/compare/v25.2.4...v26.0.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-05-18 22:06:18 +00:00
dependabot-preview[bot] 6222ef53ed Merge pull request #64 from aws-actions/dependabot/npm_and_yarn/eslint-7.0.0 2020-05-18 22:04:29 +00:00
GitHub Actions 4dffe9935f chore: Update dist 2020-05-18 21:54:35 +00:00
Piradeep Kandasamy 7a20e4d87a Merge pull request #63 from aws-actions/dependabot/npm_and_yarn/aws-sdk-2.679.0
chore: Bump aws-sdk from 2.650.0 to 2.679.0
2020-05-18 14:54:04 -07:00
Piradeep Kandasamy d0f92ec22a Merge branch 'master' into dependabot/npm_and_yarn/aws-sdk-2.679.0 2020-05-18 14:02:13 -07:00
dependabot-preview[bot] c4c5364d3e chore: Bump eslint from 6.8.0 to 7.0.0
Bumps [eslint](https://github.com/eslint/eslint) from 6.8.0 to 7.0.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/master/CHANGELOG.md)
- [Commits](https://github.com/eslint/eslint/compare/v6.8.0...v7.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-05-18 19:39:01 +00:00
GitHub Actions 5c99022f7d chore: Update dist 2020-05-18 19:38:58 +00:00
dependabot-preview[bot] 573b434a39 chore: Bump aws-sdk from 2.650.0 to 2.679.0
Bumps [aws-sdk](https://github.com/aws/aws-sdk-js) from 2.650.0 to 2.679.0.
- [Release notes](https://github.com/aws/aws-sdk-js/releases)
- [Changelog](https://github.com/aws/aws-sdk-js/blob/master/CHANGELOG.md)
- [Commits](https://github.com/aws/aws-sdk-js/compare/v2.650.0...v2.679.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-05-18 19:38:32 +00:00
dependabot-preview[bot] 4162c23c46 Merge pull request #61 from aws-actions/dependabot/npm_and_yarn/actions/core-1.2.4 2020-05-18 19:38:30 +00:00
dependabot-preview[bot] 1116bc7043 chore: Bump @actions/core from 1.2.3 to 1.2.4
Bumps [@actions/core](https://github.com/actions/toolkit/tree/HEAD/packages/core) from 1.2.3 to 1.2.4.
- [Release notes](https://github.com/actions/toolkit/releases)
- [Changelog](https://github.com/actions/toolkit/blob/master/packages/core/RELEASES.md)
- [Commits](https://github.com/actions/toolkit/commits/HEAD/packages/core)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-05-18 19:37:20 +00:00
Clare Liguori 32a3a7cc43 chore: add table of contents to README 2020-04-19 19:09:20 -07:00
Clare Liguori 35a0f3fe6c chore: make permissions section title more descriptive 2020-04-19 18:40:29 -07:00
J. Davila 0a0b8e52b4 docs: add code block tags 2020-04-15 10:42:33 -07:00
7 changed files with 1777 additions and 1174 deletions
+9
View File
@@ -2,6 +2,15 @@
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
### [1.3.5](https://github.com/aws-actions/configure-aws-credentials/compare/v1.3.4...v1.3.5) (2020-05-27)
### Bug Fixes
* clear session token env var if present for non-session credentials ([#65](https://github.com/aws-actions/configure-aws-credentials/issues/65)) ([0c2c1f7](https://github.com/aws-actions/configure-aws-credentials/commit/0c2c1f7c129971b6f433551b1f4ba4a6a9cc8b70))
### [1.3.4](https://github.com/aws-actions/configure-aws-credentials/compare/v1.3.3...v1.3.4) (2020-05-18)
### [1.3.3](https://github.com/aws-actions/configure-aws-credentials/compare/v1.3.2...v1.3.3) (2020-04-02)
### [1.3.2](https://github.com/aws-actions/configure-aws-credentials/compare/v1.3.1...v1.3.2) (2020-03-18)
+43 -12
View File
@@ -2,6 +2,21 @@
Configure AWS credential and region environment variables for use in other GitHub Actions. The environment variables will be detected by both the AWS SDKs and the AWS CLI to determine the credentials and region to use for AWS API calls.
**Table of Contents**
<!-- toc -->
- [Usage](#usage)
- [Credentials](#credentials)
- [Assuming a Role](#assuming-a-role)
+ [Permissions for assuming a role](#permissions-for-assuming-a-role)
+ [Session tagging](#session-tagging)
- [Self-Hosted Runners](#self-hosted-runners)
- [License Summary](#license-summary)
- [Security Disclosures](#security-disclosures)
<!-- tocstop -->
## Usage
Add the following step to your workflow:
@@ -16,8 +31,9 @@ Add the following step to your workflow:
```
For example, you can use this action with the AWS CLI available in [GitHub's hosted virtual environments](https://help.github.com/en/actions/reference/software-installed-on-github-hosted-runners).
You can also run this action multiple times to use different AWS accounts, regions, or IAM roles in the same GitHub Actions workflow job.
```
```yaml
jobs:
deploy:
name: Upload to Amazon S3
@@ -27,16 +43,27 @@ jobs:
- name: Checkout
uses: actions/checkout@v2
- name: Configure AWS credentials
- name: Configure AWS credentials from Test account
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: us-east-2
aws-access-key-id: ${{ secrets.TEST_AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.TEST_AWS_SECRET_ACCESS_KEY }}
aws-region: us-east-1
- name: Copy files to S3 with the AWS CLI
- name: Copy files to the test website with the AWS CLI
run: |
aws s3 sync . s3://my-s3-website-bucket
aws s3 sync . s3://my-s3-test-website-bucket
- name: Configure AWS credentials from Production account
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.PROD_AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.PROD_AWS_SECRET_ACCESS_KEY }}
aws-region: us-west-2
- name: Copy files to the production website with the AWS CLI
run: |
aws s3 sync . s3://my-s3-prod-website-bucket
```
See [action.yml](action.yml) for the full documentation for this action's inputs and outputs.
@@ -50,7 +77,7 @@ We recommend following [Amazon IAM best practices](https://docs.aws.amazon.com/I
* [Rotate the credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#rotate-credentials) used in GitHub Actions workflows regularly.
* [Monitor the activity](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#keep-a-log) of the credentials used in GitHub Actions workflows.
## Assuming a role
## Assuming a Role
If you would like to use the static credentials you provide to this action to assume a role, you can do so by specifying the role ARN in `role-to-assume`.
The role credentials will then be configured in the Actions environment instead of the static credentials you have provided.
The default session duration is 6 hours, but if you would like to adjust this you can pass a duration to `role-duration-seconds`.
@@ -71,10 +98,10 @@ Example:
```
In this example, the secret `AWS_ROLE_TO_ASSUME` contains a string like `arn:aws:iam::123456789100:role/my-github-actions-role`. To assume a role in the same account as the static credentials, you can simply specify the role name, like `role-to-assume: my-github-actions-role`.
### Permissions
### Permissions for assuming a role
In order to assume a role, the IAM user for the static credentials must have the following permissions:
```
```json
{
"Version": "2012-10-17",
"Statement": [
@@ -91,7 +118,7 @@ In order to assume a role, the IAM user for the static credentials must have the
```
The role's trust policy must allow the IAM user to assume the role:
```
```json
{
"Version": "2012-10-17",
"Statement": [
@@ -130,7 +157,7 @@ The session will have the name "GitHubActions" and be tagged with the following
_Note: all tag values must conform to [the requirements](https://docs.aws.amazon.com/STS/latest/APIReference/API_Tag.html). Particularly, `GITHUB_WORKFLOW` will be truncated if it's too long. If `GITHUB_ACTOR` or `GITHUB_WORKFLOW` contain invalid charcters, the characters will be replaced with an '*'._
## Self-hosted runners
## Self-Hosted Runners
If you run your GitHub Actions in a [self-hosted runner](https://help.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) that already has access to AWS credentials, such as an EC2 instance, then you do not need to provide IAM user access key credentials to this action.
@@ -156,3 +183,7 @@ In this case, your runner's credentials must have permissions to assume the role
## License Summary
This code is made available under the MIT license.
## Security Disclosures
If you would like to report a potential security issue in this project, please do not create a GitHub issue. Instead, please follow the instructions [here](https://aws.amazon.com/security/vulnerability-reporting/) or [email AWS security directly](mailto:aws-security@amazon.com).
+356 -160
View File
File diff suppressed because one or more lines are too long
+3
View File
@@ -107,6 +107,9 @@ function exportCredentials(params){
if (sessionToken) {
core.exportVariable('AWS_SESSION_TOKEN', sessionToken);
core.setSecret(sessionToken);
} else if (process.env.AWS_SESSION_TOKEN) {
// clear session token from previous credentials action
core.exportVariable('AWS_SESSION_TOKEN', '');
}
}
+22
View File
@@ -154,6 +154,28 @@ describe('Configure AWS Credentials', () => {
expect(core.setSecret).toHaveBeenCalledWith(FAKE_ACCOUNT_ID);
});
test('session token is cleared if necessary', async () => {
const mockInputs = {...CREDS_INPUTS, 'aws-region': 'eu-west-1'};
core.getInput = jest
.fn()
.mockImplementation(mockGetInput(mockInputs));
process.env.AWS_SESSION_TOKEN = 'helloworld';
await run();
expect(mockStsAssumeRole).toHaveBeenCalledTimes(0);
expect(core.exportVariable).toHaveBeenCalledTimes(5);
expect(core.setSecret).toHaveBeenCalledTimes(3);
expect(core.exportVariable).toHaveBeenCalledWith('AWS_ACCESS_KEY_ID', FAKE_ACCESS_KEY_ID);
expect(core.setSecret).toHaveBeenCalledWith(FAKE_ACCESS_KEY_ID);
expect(core.exportVariable).toHaveBeenCalledWith('AWS_SECRET_ACCESS_KEY', FAKE_SECRET_ACCESS_KEY);
expect(core.setSecret).toHaveBeenCalledWith(FAKE_SECRET_ACCESS_KEY);
expect(core.exportVariable).toHaveBeenCalledWith('AWS_SESSION_TOKEN', '');
expect(core.exportVariable).toHaveBeenCalledWith('AWS_DEFAULT_REGION', 'eu-west-1');
expect(core.exportVariable).toHaveBeenCalledWith('AWS_REGION', 'eu-west-1');
expect(core.setOutput).toHaveBeenCalledWith('aws-account-id', FAKE_ACCOUNT_ID);
expect(core.setSecret).toHaveBeenCalledWith(FAKE_ACCOUNT_ID);
});
test('validates region name', async () => {
process.env.SHOW_STACK_TRACE = 'false';
+1338 -996
View File
File diff suppressed because it is too large Load Diff
+6 -6
View File
@@ -1,6 +1,6 @@
{
"name": "aws-actions-configure-aws-credentials",
"version": "1.3.3",
"version": "1.3.5",
"description": "Configure AWS Credentials",
"main": "index.js",
"scripts": {
@@ -25,12 +25,12 @@
},
"homepage": "https://github.com/aws-actions/configure-aws-credentials#readme",
"dependencies": {
"@actions/core": "^1.2.3",
"aws-sdk": "^2.650.0"
"@actions/core": "^1.2.4",
"aws-sdk": "^2.684.0"
},
"devDependencies": {
"@zeit/ncc": "^0.22.0",
"eslint": "^6.8.0",
"jest": "^25.2.4"
"@zeit/ncc": "^0.22.3",
"eslint": "^7.1.0",
"jest": "^26.0.1"
}
}