Merge pull request #1 from whywaita/support-s3

Support AWS S3 and compatible software

README.md

@@ -1,3 +1,32 @@
+# whywaita/actions-cache-s3
+
+`whywaita/actions-cache-s3` is a forked Action from [@actions/cache](https://github.com/actions/cache).
+
+This Action provides Amazon Web Services S3 backend (and compatible software) for @actions/cache.
+
+## Usage
+
+```yaml
+- name: Cache multiple paths
+  uses: whywaita/actions-cache-s3@main
+  with:
+    path: |
+      ~/cache
+      !~/cache/exclude
+    key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+    restore-keys: |
+      ${{ runner.os }}-go-
+    aws-s3-bucket: ${{ secrets.AWS_S3_BUCKET_NAME }}
+    aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+    aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+    aws-region: us-east-1                      # Optional
+    aws-endpoint: https://example.com          # 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.
+
 # cache
 
 This action allows caching dependencies and build outputs to improve workflow execution time.

action.yml

@@ -14,6 +14,29 @@ inputs:
   upload-chunk-size:
     description: 'The chunk size used to split up large files during upload, in bytes'
     required: false
+  aws-s3-bucket:
+    description: 'An AWS S3 bucket to save cache'
+    required: true
+  aws-access-key-id:
+    description: 'An AWS access key id to access the bucket'
+    required: true
+  aws-secret-access-key:
+    description: 'An AWS secret access key to access the bucket'
+    required: true
+  aws-region:
+    description: 'An AWS region where the bucket is located'
+    required: false
+  aws-endpoint:
+    description: 'An endpoint of AWS S3 (for compatible software)'
+    required: false
+  aws-s3-bucket-endpoint:
+    description: 'Whether to use the bucket name as the endpoint for this request.'
+    required: false
+    default: true
+  aws-s3-force-path-style:
+    description: 'Whether to force path style URLs for S3 objects.'
+    required: false
+    default: false
 outputs:
   cache-hit:
     description: 'A boolean value to indicate an exact match was found for the primary key'

package.json

@@ -23,10 +23,12 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^1.0.9",
+    "@actions/cache": "https://gitpkg.now.sh/whywaita/toolkit/packages/cache?main",
     "@actions/core": "^1.2.6",
     "@actions/exec": "^1.0.1",
-    "@actions/io": "^1.1.0"
+    "@actions/io": "^1.1.0",
+    "@aws-sdk/client-s3": "^3.51.0",
+    "@aws-sdk/types": "^3.50.0"
   },
   "devDependencies": {
     "@types/jest": "^27.4.0",

src/constants.ts

@@ -2,7 +2,14 @@ export enum Inputs {
     Key = "key",
     Path = "path",
     RestoreKeys = "restore-keys",
-    UploadChunkSize = "upload-chunk-size"
+    UploadChunkSize = "upload-chunk-size",
+    AWSS3Bucket = "aws-s3-bucket",
+    AWSAccessKeyId = "aws-access-key-id",
+    AWSSecretAccessKey = "aws-secret-access-key",
+    AWSRegion = "aws-region",
+    AWSEndpoint = "aws-endpoint",
+    AWSS3BucketEndpoint = "aws-s3-bucket-endpoint",
+    AWSS3ForcePathStyle = "aws-s3-force-path-style"
 }
 
 export enum Outputs {

src/restore.ts

@@ -6,14 +6,6 @@ import * as utils from "./utils/actionUtils";
 
 async function run(): Promise<void> {
     try {
-        if (utils.isGhes()) {
-            utils.logWarning(
-                "Cache action is not supported on GHES. See https://github.com/actions/cache/issues/505 for more details"
-            );
-            utils.setCacheHitOutput(false);
-            return;
-        }
-
         // Validate inputs, this can cause task failure
         if (!utils.isValidEvent()) {
             utils.logWarning(
@@ -31,12 +23,17 @@ async function run(): Promise<void> {
         const cachePaths = utils.getInputAsArray(Inputs.Path, {
             required: true
         });
+        const s3BucketName = core.getInput(Inputs.AWSS3Bucket);
+        const s3config = utils.getInputS3ClientConfig();
 
         try {
             const cacheKey = await cache.restoreCache(
                 cachePaths,
                 primaryKey,
-                restoreKeys
+                restoreKeys,
+                undefined,
+                s3config,
+                s3BucketName
             );
             if (!cacheKey) {
                 core.info(

src/save.ts

@@ -11,13 +11,6 @@ process.on("uncaughtException", e => utils.logWarning(e.message));
 
 async function run(): Promise<void> {
     try {
-        if (utils.isGhes()) {
-            utils.logWarning(
-                "Cache action is not supported on GHES. See https://github.com/actions/cache/issues/505 for more details"
-            );
-            return;
-        }
-
         if (!utils.isValidEvent()) {
             utils.logWarning(
                 `Event Validation Error: The event type ${
@@ -46,11 +39,13 @@ async function run(): Promise<void> {
         const cachePaths = utils.getInputAsArray(Inputs.Path, {
             required: true
         });
+        const s3BucketName = core.getInput(Inputs.AWSS3Bucket);
+        const s3config = utils.getInputS3ClientConfig();
 
         try {
             await cache.saveCache(cachePaths, primaryKey, {
                 uploadChunkSize: utils.getInputAsInt(Inputs.UploadChunkSize)
-            });
+            }, s3config, s3BucketName);
             core.info(`Cache saved with key: ${primaryKey}`);
         } catch (error) {
             if (error.name === cache.ValidationError.name) {

src/utils/actionUtils.ts

@@ -1,6 +1,8 @@
 import * as core from "@actions/core";
 
-import { Outputs, RefKey, State } from "../constants";
+import { Inputs, Outputs, RefKey, State } from "../constants";
+
+import {CommonPrefix, InputSerialization, S3ClientConfig} from "@aws-sdk/client-s3";
 
 export function isGhes(): boolean {
     const ghUrl = new URL(
@@ -74,3 +76,25 @@ export function getInputAsInt(
     }
     return value;
 }
+
+export function getInputS3ClientConfig(): S3ClientConfig | undefined {
+    const s3BucketName = core.getInput(Inputs.AWSS3Bucket)
+    if (!s3BucketName) {
+        return undefined
+    }
+
+    const s3config = {
+        credentials: {
+          accessKeyId: core.getInput(Inputs.AWSAccessKeyId),
+          secretAccessKey: core.getInput(Inputs.AWSSecretAccessKey)
+        },
+        region: core.getInput(Inputs.AWSRegion),
+        endpoint: core.getInput(Inputs.AWSEndpoint),
+        bucketEndpoint: core.getBooleanInput(Inputs.AWSS3BucketEndpoint),
+        forcePathStyle: core.getBooleanInput(Inputs.AWSS3ForcePathStyle),
+    } as S3ClientConfig
+
+    core.debug('Enable S3 backend mode.')
+
+    return s3config
+}