Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for multiple profiles with credentials file #633

Closed
wants to merge 1 commit into from
Closed

Add support for multiple profiles with credentials file #633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions .prettierrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"singleQuote": false,
"arrowParens": "always",
"trailingComma": "all",
"printWidth": 120,
"bracketSpacing": true,
"semi": true
}
195 changes: 114 additions & 81 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

74 changes: 74 additions & 0 deletions __snapshots__/index.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`Configure AWS Credentials Profile Support add new profile if credentials file already exists 1`] = `
"[profile default]
region=fake-region-1

[profile test-profile]
region=fake-region-1
role_arn=arn:aws:iam::111111111111:role/MY-ROLE
role_session_name=GitHubActions
"
`;

exports[`Configure AWS Credentials Profile Support add new profile if credentials file already exists 2`] = `
"[default]
aws_access_key=STS-AWS-ACCESS-KEY-ID
aws_secret_access_key=STS-AWS-SECRET-ACCESS-KEY
aws_session_token=STS-AWS-SESSION-TOKEN

[test-profile]
aws_access_key_id=STS-AWS-ACCESS-KEY-ID
aws_secret_access_key=STS-AWS-SECRET-ACCESS-KEY
aws_session_token=STS-AWS-SESSION-TOKEN
"
`;

exports[`Configure AWS Credentials Profile Support only role arn and region provided to use GH OIDC Token 1`] = `
"[profile test-profile]
region=fake-region-1
role_arn=arn:aws:iam::111111111111:role/MY-ROLE
role_session_name=GitHubActions
"
`;

exports[`Configure AWS Credentials Profile Support only role arn and region provided to use GH OIDC Token 2`] = `
"[test-profile]
aws_access_key_id=STS-AWS-ACCESS-KEY-ID
aws_secret_access_key=STS-AWS-SECRET-ACCESS-KEY
aws_session_token=STS-AWS-SESSION-TOKEN
"
`;

exports[`Configure AWS Credentials Profile Support use profile and save credentials file 1`] = `
"[profile test-profile]
region=fake-region-1
role_arn=arn:aws:iam::111111111111:role/MY-ROLE
role_session_name=GitHubActions
"
`;

exports[`Configure AWS Credentials Profile Support use profile and save credentials file 2`] = `
"[test-profile]
aws_access_key_id=STS-AWS-ACCESS-KEY-ID
aws_secret_access_key=STS-AWS-SECRET-ACCESS-KEY
aws_session_token=STS-AWS-SESSION-TOKEN
"
`;

exports[`Configure AWS Credentials Profile Support web identity token file provided with relative path 1`] = `
"[profile test-profile]
region=fake-region-1
web_identity_token_file=fake/token/file
role_arn=arn:aws:iam::111111111111:role/MY-ROLE
role_session_name=GitHubActions
"
`;

exports[`Configure AWS Credentials Profile Support web identity token file provided with relative path 2`] = `
"[test-profile]
aws_access_key_id=STS-AWS-ACCESS-KEY-ID
aws_secret_access_key=STS-AWS-SECRET-ACCESS-KEY
aws_session_token=STS-AWS-SESSION-TOKEN
"
`;
27 changes: 15 additions & 12 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: '"Configure AWS Credentials" Action For GitHub Actions'
description: 'Configure AWS credential and region environment variables for use with the AWS CLI and AWS SDKs'
description: "Configure AWS credential and region environment variables for use with the AWS CLI and AWS SDKs"
branding:
icon: 'cloud'
color: 'orange'
icon: "cloud"
color: "orange"
inputs:
audience:
default: 'sts.amazonaws.com'
description: 'The audience to use for the OIDC provider'
default: "sts.amazonaws.com"
description: "The audience to use for the OIDC provider"
required: false
aws-access-key-id:
description: >-
Expand All @@ -20,11 +20,14 @@ inputs:
It is optional if running in a self-hosted environment that already has AWS credentials,
for example on an EC2 instance.
required: false
aws-profile:
description: "AWS Profile"
required: false
aws-session-token:
description: 'AWS Session Token'
description: "AWS Session Token"
required: false
aws-region:
description: 'AWS Region, e.g. us-east-2'
description: "AWS Region, e.g. us-east-2"
required: true
mask-aws-account-id:
description: >-
Expand All @@ -47,20 +50,20 @@ inputs:
description: "Role duration in seconds (default: 6 hours, 1 hour for OIDC/specified aws-session-token)"
required: false
role-session-name:
description: 'Role session name (default: GitHubActions)'
description: "Role session name (default: GitHubActions)"
required: false
role-external-id:
description: 'The external ID of the role to assume'
description: "The external ID of the role to assume"
required: false
role-skip-session-tagging:
description: 'Skip session tagging during role assumption'
description: "Skip session tagging during role assumption"
required: false
http-proxy:
description: 'Proxy to use for the AWS SDK agent'
description: "Proxy to use for the AWS SDK agent"
required: false
outputs:
aws-account-id:
description: 'The AWS account ID for the provided credentials'
description: "The AWS account ID for the provided credentials"
runs:
using: 'node12'
main: 'dist/index.js'
Expand Down
18 changes: 10 additions & 8 deletions cleanup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
const core = require('@actions/core');
const core = require("@actions/core");
const fs = require("fs");

/**
* When the GitHub Actions job is done, clean up any environment variables that
Expand All @@ -17,13 +18,14 @@ async function cleanup() {
// environment variables, so we overwrite the current value with an empty
// string. The AWS CLI and AWS SDKs will behave correctly: they treat an
// empty string value as if the environment variable does not exist.
core.exportVariable('AWS_ACCESS_KEY_ID', '');
core.exportVariable('AWS_SECRET_ACCESS_KEY', '');
core.exportVariable('AWS_SESSION_TOKEN', '');
core.exportVariable('AWS_DEFAULT_REGION', '');
core.exportVariable('AWS_REGION', '');
}
catch (error) {
core.exportVariable("AWS_ACCESS_KEY_ID", "");
core.exportVariable("AWS_SECRET_ACCESS_KEY", "");
core.exportVariable("AWS_SESSION_TOKEN", "");
core.exportVariable("AWS_DEFAULT_REGION", "");
core.exportVariable("AWS_REGION", "");

fs.rmSync(`${process.env.HOME}/.aws`, { force: true, recursive: true });
} catch (error) {
core.setFailed(error.message);
}
}
Expand Down
16 changes: 9 additions & 7 deletions dist/cleanup/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {

const core = __nccwpck_require__(186);
const fs = __nccwpck_require__(147);

/**
* When the GitHub Actions job is done, clean up any environment variables that
Expand All @@ -23,13 +24,14 @@ async function cleanup() {
// environment variables, so we overwrite the current value with an empty
// string. The AWS CLI and AWS SDKs will behave correctly: they treat an
// empty string value as if the environment variable does not exist.
core.exportVariable('AWS_ACCESS_KEY_ID', '');
core.exportVariable('AWS_SECRET_ACCESS_KEY', '');
core.exportVariable('AWS_SESSION_TOKEN', '');
core.exportVariable('AWS_DEFAULT_REGION', '');
core.exportVariable('AWS_REGION', '');
}
catch (error) {
core.exportVariable("AWS_ACCESS_KEY_ID", "");
core.exportVariable("AWS_SECRET_ACCESS_KEY", "");
core.exportVariable("AWS_SESSION_TOKEN", "");
core.exportVariable("AWS_DEFAULT_REGION", "");
core.exportVariable("AWS_REGION", "");

fs.rmSync(`${process.env.HOME}/.aws`, { force: true, recursive: true });
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GeertWille Please recheck this line/imports
Looks like something went wrong, getting this error:

Post job cleanup.
Error: fs.rmSync is not a function

} catch (error) {
core.setFailed(error.message);
}
}
Expand Down