feat: Add predefinedAcl option (#28) (#31)

* Make predefinedAcl parameter

* Write README

* lint --fix

* Update action.yml

* Build

* Revert "Build"

This reverts commit 27d78ae.

* Change predefinedAcl example

Co-authored-by: Hideo Yasumoto <hideo54@hideo54.com>

Author: bharathkkb

README.md

@@ -116,6 +116,16 @@ The files will be uploaded to `gs://bucket-name/folder/file1`,`gs://bucket-name/
 
   In the above example, the file(s) will be uploaded without `gzip` content-encoding
 
+- `predefinedAcl`: (Optional) Apply a predefined set of access controls to the file(s).
+
+  ```yaml
+  predefinedAcl: projectPrivate
+  ```
+
+  In the above example, project team members get access to the uploaded file(s) according to their roles.
+
+  Acceptable values are: `authenticatedRead`, `bucketOwnerFullControl`, `bucketOwnerRead`, `private`, `projectPrivate`, `publicRead`. See [the document](https://googleapis.dev/nodejs/storage/latest/global.html#UploadOptions) for details.
+
 - `credentials`: (Optional) [Google Service Account JSON][sa] credentials as JSON or base64 encoded string,
   typically sourced from a [GitHub Secret][gh-secret]. If unspecified, other
   authentication methods are attempted. See [Authorization](#Authorization) below.

action.yml

@@ -24,6 +24,10 @@ inputs:
     description: |-
       Upload file(s) with gzip content encoding, defaults to true.
     required: false
+  predefinedAcl:
+    description: |-
+      Apply a predefined set of access controls to the file(s).
+    required: false
 
 runs:
   using: "node12"

src/client.ts

@@ -16,7 +16,12 @@
 
 import * as fs from 'fs';
 import { UploadHelper } from './upload-helper';
-import { Storage, UploadResponse, StorageOptions } from '@google-cloud/storage';
+import {
+  Storage,
+  UploadResponse,
+  StorageOptions,
+  PredefinedAcl,
+} from '@google-cloud/storage';
 
 /**
  * Available options to create the client.
@@ -64,6 +69,7 @@ export class Client {
     destination: string,
     path: string,
     gzip: boolean,
+    predefinedAcl?: PredefinedAcl,
   ): Promise<UploadResponse[]> {
     let bucketName = destination;
     let prefix = '';
@@ -82,6 +88,7 @@ export class Client {
         path,
         gzip,
         prefix,
+        predefinedAcl,
       );
       return [uploadedFile];
     } else {
@@ -90,6 +97,7 @@ export class Client {
         path,
         gzip,
         prefix,
+        predefinedAcl,
       );
       return uploadedFiles;
     }

src/main.ts

@@ -15,6 +15,7 @@
  */
 
 import * as core from '@actions/core';
+import { PredefinedAcl } from '@google-cloud/storage';
 import { Client } from './client';
 
 async function run(): Promise<void> {
@@ -23,9 +24,21 @@ async function run(): Promise<void> {
     const destination = core.getInput('destination', { required: true });
     const gzip =
       core.getInput('gzip', { required: false }) === 'false' ? false : true;
+    const predefinedAclInput = core.getInput('predefinedAcl', {
+      required: false,
+    });
+    const predefinedAcl =
+      predefinedAclInput === ''
+        ? undefined
+        : (predefinedAclInput as PredefinedAcl);
     const serviceAccountKey = core.getInput('credentials');
     const client = new Client({ credentials: serviceAccountKey });
-    const uploadResponses = await client.upload(destination, path, gzip);
+    const uploadResponses = await client.upload(
+      destination,
+      path,
+      gzip,
+      predefinedAcl,
+    );
 
     core.setOutput(
       'uploaded',

src/upload-helper.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Storage, UploadResponse } from '@google-cloud/storage';
+import { PredefinedAcl, Storage, UploadResponse } from '@google-cloud/storage';
 import * as path from 'path';
 import { getFiles } from './util';
 
@@ -48,12 +48,14 @@ export class UploadHelper {
     filename: string,
     gzip: boolean,
     destination?: string,
+    predefinedAcl?: PredefinedAcl,
   ): Promise<UploadResponse> {
     interface UploadOptions {
       gzip: boolean;
       destination?: string;
+      predefinedAcl?: PredefinedAcl;
     }
-    const options: UploadOptions = { gzip };
+    const options: UploadOptions = { gzip, predefinedAcl };
     if (destination) {
       // If obj prefix is set, then extract filename and append to prefix.
       options.destination = `${destination}/${path.posix.basename(filename)}`;
@@ -79,6 +81,7 @@ export class UploadHelper {
     directoryPath: string,
     gzip: boolean,
     prefix = '',
+    predefinedAcl?: PredefinedAcl,
   ): Promise<UploadResponse[]> {
     const pathDirName = path.posix.dirname(directoryPath);
     // Get list of files in the directory.
@@ -100,6 +103,7 @@ export class UploadHelper {
           filePath,
           gzip,
           destination,
+          predefinedAcl,
         );
         return uploadResp;
       }),