actions/cache
1
0
Fork 0
mirror of https://code.forgejo.org/actions/cache.git synced 2025-04-02 04:57:46 +02:00
Code Activity

Add support for aws session token (#16)

Browse source 
* Added support for supplying session token

* Update build

* Updated documentation

* Updated readme
This commit is contained in:
Knut Eirik Leira Hjelle 2023-12-29 23:56:47 +05:30 • committed by GitHub
parent 9b747acaaa
commit c43c7a3f1b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 31 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -4,6 +4,8 @@
This Action provides Amazon Web Services S3 backend (and compatible software) for @actions/cache. This Action provides Amazon Web Services S3 backend (and compatible software) for @actions/cache.
It supports assuming credentials from `aws-actions/configure-aws-credentials` directly from `env`, or you can supply them through inputs.
## Usage ## Usage
```yaml ```yaml
@ -19,10 +21,11 @@ This Action provides Amazon Web Services S3 backend (and compatible software) fo
aws-s3-bucket: ${{ secrets.AWS_S3_BUCKET_NAME }} aws-s3-bucket: ${{ secrets.AWS_S3_BUCKET_NAME }}
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: us-east-1 # Optional aws-session-token: ${{ secrets.AWS_SESSION_TOKEN }} # Optionally supply session token from aws-actions/configure-aws-credentials
aws-endpoint: https://example.com # Optional aws-region: us-east-1 # Optional
aws-s3-bucket-endpoint: false # Optional aws-endpoint: https://example.com # Optional
aws-s3-force-path-style: true # Optional aws-s3-bucket-endpoint: false # Optional
aws-s3-force-path-style: true # Optional
``` ```
Please see [actions.yml](https://github.com/whywaita/actions-cache-s3/blob/main/action.yml) about input parameters. Please see [actions.yml](https://github.com/whywaita/actions-cache-s3/blob/main/action.yml) about input parameters.

3
action.yml
View file

@ -35,6 +35,9 @@ inputs:
aws-secret-access-key: aws-secret-access-key:
description: 'An AWS secret access key to access the bucket' description: 'An AWS secret access key to access the bucket'
required: false required: false
aws-session-token:
description: 'An AWS session token to access the bucket'
required: false
aws-region: aws-region:
description: 'An AWS region where the bucket is located' description: 'An AWS region where the bucket is located'
required: false required: false

5
dist/restore-only/index.js vendored
View file

@ -15855,7 +15855,9 @@ function getInputS3ClientConfig() {
accessKeyId: core.getInput(constants_1.Inputs.AWSAccessKeyId) || accessKeyId: core.getInput(constants_1.Inputs.AWSAccessKeyId) ||
process.env["AWS_ACCESS_KEY_ID"], process.env["AWS_ACCESS_KEY_ID"],
secretAccessKey: core.getInput(constants_1.Inputs.AWSSecretAccessKey) || secretAccessKey: core.getInput(constants_1.Inputs.AWSSecretAccessKey) ||
process.env["AWS_SECRET_ACCESS_KEY"] process.env["AWS_SECRET_ACCESS_KEY"],
sessionToken: core.getInput(constants_1.Inputs.AWSSessionToken) ||
process.env["AWS_SESSION_TOKEN"]
}, },
region: core.getInput(constants_1.Inputs.AWSRegion) || process.env["AWS_REGION"], region: core.getInput(constants_1.Inputs.AWSRegion) || process.env["AWS_REGION"],
endpoint: core.getInput(constants_1.Inputs.AWSEndpoint), endpoint: core.getInput(constants_1.Inputs.AWSEndpoint),
@ -46971,6 +46973,7 @@ var Inputs;
Inputs["AWSS3Bucket"] = "aws-s3-bucket"; Inputs["AWSS3Bucket"] = "aws-s3-bucket";
Inputs["AWSAccessKeyId"] = "aws-access-key-id"; Inputs["AWSAccessKeyId"] = "aws-access-key-id";
Inputs["AWSSecretAccessKey"] = "aws-secret-access-key"; Inputs["AWSSecretAccessKey"] = "aws-secret-access-key";
Inputs["AWSSessionToken"] = "aws-session-token";
Inputs["AWSRegion"] = "aws-region"; Inputs["AWSRegion"] = "aws-region";
Inputs["AWSEndpoint"] = "aws-endpoint"; Inputs["AWSEndpoint"] = "aws-endpoint";
Inputs["AWSS3BucketEndpoint"] = "aws-s3-bucket-endpoint"; Inputs["AWSS3BucketEndpoint"] = "aws-s3-bucket-endpoint";

5
dist/restore/index.js vendored
View file

@ -15855,7 +15855,9 @@ function getInputS3ClientConfig() {
accessKeyId: core.getInput(constants_1.Inputs.AWSAccessKeyId) || accessKeyId: core.getInput(constants_1.Inputs.AWSAccessKeyId) ||
process.env["AWS_ACCESS_KEY_ID"], process.env["AWS_ACCESS_KEY_ID"],
secretAccessKey: core.getInput(constants_1.Inputs.AWSSecretAccessKey) || secretAccessKey: core.getInput(constants_1.Inputs.AWSSecretAccessKey) ||
process.env["AWS_SECRET_ACCESS_KEY"] process.env["AWS_SECRET_ACCESS_KEY"],
sessionToken: core.getInput(constants_1.Inputs.AWSSessionToken) ||
process.env["AWS_SESSION_TOKEN"]
}, },
region: core.getInput(constants_1.Inputs.AWSRegion) || process.env["AWS_REGION"], region: core.getInput(constants_1.Inputs.AWSRegion) || process.env["AWS_REGION"],
endpoint: core.getInput(constants_1.Inputs.AWSEndpoint), endpoint: core.getInput(constants_1.Inputs.AWSEndpoint),
@ -46971,6 +46973,7 @@ var Inputs;
Inputs["AWSS3Bucket"] = "aws-s3-bucket"; Inputs["AWSS3Bucket"] = "aws-s3-bucket";
Inputs["AWSAccessKeyId"] = "aws-access-key-id"; Inputs["AWSAccessKeyId"] = "aws-access-key-id";
Inputs["AWSSecretAccessKey"] = "aws-secret-access-key"; Inputs["AWSSecretAccessKey"] = "aws-secret-access-key";
Inputs["AWSSessionToken"] = "aws-session-token";
Inputs["AWSRegion"] = "aws-region"; Inputs["AWSRegion"] = "aws-region";
Inputs["AWSEndpoint"] = "aws-endpoint"; Inputs["AWSEndpoint"] = "aws-endpoint";
Inputs["AWSS3BucketEndpoint"] = "aws-s3-bucket-endpoint"; Inputs["AWSS3BucketEndpoint"] = "aws-s3-bucket-endpoint";

5
dist/save-only/index.js vendored
View file

@ -15855,7 +15855,9 @@ function getInputS3ClientConfig() {
accessKeyId: core.getInput(constants_1.Inputs.AWSAccessKeyId) || accessKeyId: core.getInput(constants_1.Inputs.AWSAccessKeyId) ||
process.env["AWS_ACCESS_KEY_ID"], process.env["AWS_ACCESS_KEY_ID"],
secretAccessKey: core.getInput(constants_1.Inputs.AWSSecretAccessKey) || secretAccessKey: core.getInput(constants_1.Inputs.AWSSecretAccessKey) ||
process.env["AWS_SECRET_ACCESS_KEY"] process.env["AWS_SECRET_ACCESS_KEY"],
sessionToken: core.getInput(constants_1.Inputs.AWSSessionToken) ||
process.env["AWS_SESSION_TOKEN"]
}, },
region: core.getInput(constants_1.Inputs.AWSRegion) || process.env["AWS_REGION"], region: core.getInput(constants_1.Inputs.AWSRegion) || process.env["AWS_REGION"],
endpoint: core.getInput(constants_1.Inputs.AWSEndpoint), endpoint: core.getInput(constants_1.Inputs.AWSEndpoint),
@ -46971,6 +46973,7 @@ var Inputs;
Inputs["AWSS3Bucket"] = "aws-s3-bucket"; Inputs["AWSS3Bucket"] = "aws-s3-bucket";
Inputs["AWSAccessKeyId"] = "aws-access-key-id"; Inputs["AWSAccessKeyId"] = "aws-access-key-id";
Inputs["AWSSecretAccessKey"] = "aws-secret-access-key"; Inputs["AWSSecretAccessKey"] = "aws-secret-access-key";
Inputs["AWSSessionToken"] = "aws-session-token";
Inputs["AWSRegion"] = "aws-region"; Inputs["AWSRegion"] = "aws-region";
Inputs["AWSEndpoint"] = "aws-endpoint"; Inputs["AWSEndpoint"] = "aws-endpoint";
Inputs["AWSS3BucketEndpoint"] = "aws-s3-bucket-endpoint"; Inputs["AWSS3BucketEndpoint"] = "aws-s3-bucket-endpoint";

5
dist/save/index.js vendored
View file

@ -15855,7 +15855,9 @@ function getInputS3ClientConfig() {
accessKeyId: core.getInput(constants_1.Inputs.AWSAccessKeyId) || accessKeyId: core.getInput(constants_1.Inputs.AWSAccessKeyId) ||
process.env["AWS_ACCESS_KEY_ID"], process.env["AWS_ACCESS_KEY_ID"],
secretAccessKey: core.getInput(constants_1.Inputs.AWSSecretAccessKey) || secretAccessKey: core.getInput(constants_1.Inputs.AWSSecretAccessKey) ||
process.env["AWS_SECRET_ACCESS_KEY"] process.env["AWS_SECRET_ACCESS_KEY"],
sessionToken: core.getInput(constants_1.Inputs.AWSSessionToken) ||
process.env["AWS_SESSION_TOKEN"]
}, },
region: core.getInput(constants_1.Inputs.AWSRegion) || process.env["AWS_REGION"], region: core.getInput(constants_1.Inputs.AWSRegion) || process.env["AWS_REGION"],
endpoint: core.getInput(constants_1.Inputs.AWSEndpoint), endpoint: core.getInput(constants_1.Inputs.AWSEndpoint),
@ -46971,6 +46973,7 @@ var Inputs;
Inputs["AWSS3Bucket"] = "aws-s3-bucket"; Inputs["AWSS3Bucket"] = "aws-s3-bucket";
Inputs["AWSAccessKeyId"] = "aws-access-key-id"; Inputs["AWSAccessKeyId"] = "aws-access-key-id";
Inputs["AWSSecretAccessKey"] = "aws-secret-access-key"; Inputs["AWSSecretAccessKey"] = "aws-secret-access-key";
Inputs["AWSSessionToken"] = "aws-session-token";
Inputs["AWSRegion"] = "aws-region"; Inputs["AWSRegion"] = "aws-region";
Inputs["AWSEndpoint"] = "aws-endpoint"; Inputs["AWSEndpoint"] = "aws-endpoint";
Inputs["AWSS3BucketEndpoint"] = "aws-s3-bucket-endpoint"; Inputs["AWSS3BucketEndpoint"] = "aws-s3-bucket-endpoint";

1
src/constants.ts
View file

@ -9,6 +9,7 @@ export enum Inputs {
AWSS3Bucket = "aws-s3-bucket", AWSS3Bucket = "aws-s3-bucket",
AWSAccessKeyId = "aws-access-key-id", AWSAccessKeyId = "aws-access-key-id",
AWSSecretAccessKey = "aws-secret-access-key", AWSSecretAccessKey = "aws-secret-access-key",
AWSSessionToken = "aws-session-token",
AWSRegion = "aws-region", AWSRegion = "aws-region",
AWSEndpoint = "aws-endpoint", AWSEndpoint = "aws-endpoint",
AWSS3BucketEndpoint = "aws-s3-bucket-endpoint", AWSS3BucketEndpoint = "aws-s3-bucket-endpoint",

5
src/utils/actionUtils.ts
View file

@ -93,7 +93,10 @@ export function getInputS3ClientConfig(): S3ClientConfig | undefined {
process.env["AWS_ACCESS_KEY_ID"], process.env["AWS_ACCESS_KEY_ID"],
secretAccessKey: secretAccessKey:
core.getInput(Inputs.AWSSecretAccessKey) || core.getInput(Inputs.AWSSecretAccessKey) ||
process.env["AWS_SECRET_ACCESS_KEY"] process.env["AWS_SECRET_ACCESS_KEY"],
sessionToken:
core.getInput(Inputs.AWSSessionToken) ||
process.env["AWS_SESSION_TOKEN"]
}, },
region: core.getInput(Inputs.AWSRegion) || process.env["AWS_REGION"], region: core.getInput(Inputs.AWSRegion) || process.env["AWS_REGION"],
endpoint: core.getInput(Inputs.AWSEndpoint), endpoint: core.getInput(Inputs.AWSEndpoint),