feat: Custom tree hash input

README.md

@@ -44,6 +44,7 @@ order to determine the repo state.
 | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------- |
 | bucket-name           | Name of the S3 bucket to use for storing cache files. The job needs to have AWS credentials configured to allow read/write from this bucket.                                | `true`   |                   |
 | key-prefix            | Key prefix to add to the cache files key. By default the job ID is used. The full key used for the cache files is `cache/${repoOwner}/${repoName}/${keyPrefix}/${treeHash}` | `false`  | ${{ github.job }} |
+| custom-hash           | Hash calculated on the user's side used as part of the cache key for the job run.                                                                                           | `false`  |                   |
 | aws-region            | AWS region for the S3 bucket used for cache files. available.                                                                                                               | `true`   |                   |
 | aws-access-key-id     | Access Key ID for an IAM user with permissions to read/write to the S3 bucket used for cache files.                                                                         | `true`   |                   |
 | aws-secret-access-key | Secret Access Key for an IAM user with permissions to read/write to the S3 bucket used for cache files.                                                                     | `true`   |                   |

action.yml

@@ -14,6 +14,10 @@ inputs:
             used for the cache files is `cache/${repoOwner}/${repoName}/${keyPrefix}/${treeHash}`
         default: ${{ github.job }}
         required: false
+    custom-hash:
+        description:
+            Hash calculated on the user's side used as part of the cache key for the job run.
+        required: false
     aws-region:
         description: AWS region for the S3 bucket used for cache files. available.
         required: true

src/restore.test.ts

@@ -75,4 +75,27 @@ describe(`S3 Cache Action - Restore cache`, () => {
             })
         }
     )
+
+    test(
+        strip`
+        When a custom hash is provided
+        Then it should use the custom hash instead of the auto-generated one
+        `,
+        async () => {
+            const treeHash = 'cba2d570993b9c21e3de282e5ba56d1638fb32de'
+            const customHash = '070e5b3591d571974f31f594d6f841ea'
+            mockedUtils.getCurrentRepoTreeHash.mockResolvedValue(treeHash)
+            mockedUtils.fileExistsInS3.mockResolvedValue(true)
+
+            const output = await restoreS3Cache({
+                bucket: 'my-other-bucket',
+                keyPrefix: 'horse',
+                repo: {owner: 'my-org', repo: 'my-repo'},
+                awsOptions,
+                customHash
+            })
+
+            expect(output.treeHash).toBe(customHash)
+        }
+    )
 })

src/restore.ts

@@ -13,14 +13,15 @@ import {getCurrentRepoTreeHash, fileExistsInS3, runAction, AWSOptions} from './u
 runAction(async () => {
     const bucket = getInput('bucket-name', {required: true})
     const keyPrefix = getInput('key-prefix')
+    const customHash = getInput('custom-hash')
     const repo = github.context.repo
     const awsOptions = {
         region: getInput('aws-region'),
         accessKeyId: getInput('aws-access-key-id'),
         secretAccessKey: getInput('aws-secret-access-key')
     }
 
-    const output = await restoreS3Cache({bucket, keyPrefix, repo, awsOptions})
+    const output = await restoreS3Cache({bucket, keyPrefix, customHash, repo, awsOptions})
 
     // Saving key and hash in "state" which can be retrieved by the
     // "post" run of the action (save.ts)
@@ -35,17 +36,20 @@ runAction(async () => {
 type RestoreS3CacheActionArgs = {
     bucket: string
     keyPrefix: string
+    customHash?: string
     repo: {owner: string; repo: string}
     awsOptions: AWSOptions
 }
 
 export async function restoreS3Cache({
     bucket,
     keyPrefix,
+    customHash,
     repo,
     awsOptions
 }: RestoreS3CacheActionArgs) {
-    const treeHash = await getCurrentRepoTreeHash()
+    const currentRepoTreeHash = await getCurrentRepoTreeHash()
+    const treeHash = customHash || currentRepoTreeHash
 
     const key = `cache/${repo.owner}/${repo.repo}/${keyPrefix}/${treeHash}`
     const fileExists = await fileExistsInS3({key, bucket, awsOptions})