Merge pull request #8 from badsyntax/modified-files

Return modified keys for all actions
badsyntax · Dec 13, 2021 · 9195548 · 9195548
2 parents 1484cce + 169cdd3
commit 9195548
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 23 deletions.
diff --git a/.github/workflows/sync-s3.yml b/.github/workflows/sync-s3.yml
@@ -69,5 +69,5 @@ jobs:
           echo "Synced Immutable Files: $S3SyncedImmutableFiles"
         env:
           # Use outputs from the S3 step
-          S3SyncedHTMLFiles: ${{ steps.sync-html-s3.outputs.S3SyncedFiles }}
-          S3SyncedImmutableFiles: ${{ steps.sync-immutable-s3.outputs.S3SyncedFiles }}
+          S3SyncedHTMLFiles: ${{ steps.sync-html-s3.outputs.modifiedKeys }}
+          S3SyncedImmutableFiles: ${{ steps.sync-immutable-s3.outputs.modifiedKeys }}
diff --git a/README.md b/README.md
@@ -70,15 +70,15 @@ jobs:
 
       - name: Output Synced Files
         run: |
-          echo "Synced HTML Files: $S3SyncedHTMLFiles"
+          echo "Synced object keys: $S3SyncedFiles"
         env:
           # Use outputs from previous sync steps
-          S3SyncedHTMLFiles: ${{ steps.sync-html-s3.outputs.S3SyncedFiles }}
+          S3SyncedFiles: ${{ steps.sync-html-s3.outputs.modifiedKeys }}
 ```
 
 ## Action Inputs
 
-| key                             | description                                                                                                                                               | example                             |
+| Name                            | Description                                                                                                                                               | Example                             |
 | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
 | `bucket`                        | The name of the S3 bucket                                                                                                                                 | `example-bucket-us-east-1`          |
 | `action`                        | The action to perform. Accepted values: `sync` or `clean`                                                                                                 | `sync`                              |
@@ -90,6 +90,12 @@ jobs:
 | `stripExtensionGlob` (optional) | Glob pattern to strip extension (if using the sync action)                                                                                                | `**/**.html`                        |
 | `acl` (optional)                | Access control list (options: `authenticated-read, aws-exec-read, bucket-owner-full-control, bucket-owner-read, private, public-read, public-read-write`) | `private`                           |
 
+## Action Outputs
+
+| Name           | Description                                                               | Example                   |
+| -------------- | ------------------------------------------------------------------------- | ------------------------- |
+| `modifiedKeys` | A comma separated list of modified object keys (either synced or removed) | `file1,folder1/file2.ext` |
+
 ## Related GitHub Actions
 
 - [badsyntax/github-action-aws-cloudfront](https://github.com/badsyntax/github-action-aws-cloudfront)

diff --git a/action.yml b/action.yml
@@ -39,8 +39,8 @@ inputs:
     default: ''
     description: '"authenticated-read" | "aws-exec-read" | "bucket-owner-full-control" | "bucket-owner-read" | "private" | "public-read" | "public-read-write"'
 outputs:
-  S3SyncedFiles:
-    description: 'A comma separated list of objects keys for files synced to S3. For example: file1,folder1/file2'
+  modifiedKeys:
+    description: 'A comma separated list of modified object keys (either synced or removed). For example: file1,folder1/file2.ext'
 runs:
   using: 'node16'
   main: 'dist/index.js'
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/out/blog.html b/out/blog.html
@@ -8,6 +8,6 @@
     <link rel="stylesheet" href="./css/styles.css" />
   </head>
   <body>
-    BLOG 1
+    BLOG 2
   </body>
 </html>
diff --git a/out/index.html b/out/index.html
@@ -8,6 +8,6 @@
     <link rel="stylesheet" href="./css/styles.css" />
   </head>
   <body>
-    hello there 1
+    hello there 2
   </body>
 </html>
diff --git a/src/github.ts b/src/github.ts
@@ -3,5 +3,5 @@ import { info } from '@actions/core';
 export const workspace = process.env.GITHUB_WORKSPACE;
 
 export function logOutputParameters(syncedFiles: string[]): void {
-  info(`::set-output name=S3SyncedFiles::${syncedFiles.join(',')}`);
+  info(`::set-output name=modifiedKeys::${syncedFiles.join(',')}`);
 }
diff --git a/src/main.ts b/src/main.ts
@@ -28,13 +28,14 @@ export async function run(): Promise<void> {
       );
       logOutputParameters(syncedFiles);
     } else if (inputs.action === 'clean') {
-      const totalObjectsCleaned = await emptyS3Directory(
+      const cleanedFiles = await emptyS3Directory(
         s3Client,
         inputs.bucket,
         inputs.prefix
       );
+      logOutputParameters(cleanedFiles);
       info(
-        `Cleaned ${totalObjectsCleaned} from s3://${inputs.bucket}/${inputs.prefix}`
+        `Cleaned ${cleanedFiles.length} from s3://${inputs.bucket}/${inputs.prefix}`
       );
     }
   } catch (error) {

diff --git a/src/s3.ts b/src/s3.ts
@@ -187,8 +187,8 @@ export async function emptyS3Directory(
   client: S3Client,
   s3BucketName: string,
   prefix: string,
-  initialObjectsCleaned = 0
-): Promise<number> {
+  initialObjectsCleaned: string[] = []
+): Promise<string[]> {
   const objects = await client.send(
     new ListObjectsV2Command({
       Bucket: s3BucketName,
@@ -200,14 +200,18 @@ export async function emptyS3Directory(
     return initialObjectsCleaned;
   }
 
+  const objectKeys = objects.Contents.map(({ Key }) => ({ Key }));
+
   await client.send(
     new DeleteObjectsCommand({
       Bucket: s3BucketName,
-      Delete: { Objects: objects.Contents.map(({ Key }) => ({ Key })) },
+      Delete: { Objects: objectKeys },
     })
   );
 
-  const totalObjectsCleaned = initialObjectsCleaned + objects.Contents.length;
+  const totalObjectsCleaned = initialObjectsCleaned
+    .concat(objectKeys.map(({ Key }) => Key || ''))
+    .filter(Boolean);
 
   if (objects.IsTruncated) {
     return await emptyS3Directory(
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,6 +8,6 @@ @@
         <link rel="stylesheet" href="./css/styles.css" />
       </head>
       <body>
-        BLOG 1
+        BLOG 2
       </body>
     </html>