feat: add dry-run option

Co-authored-by: hiraginoyuki <[email protected]>

action.yml

@@ -14,6 +14,10 @@ inputs:
     description: 'The GitHub token used to manage repository action cache'
     required: true
     default: ${{ github.token }}
+  dry-run:
+    description: 'dry-run caches deletion'
+    required: false
+    default: 'false'
 
 # Define your outputs here.
 

src/main.ts

@@ -11,13 +11,18 @@ const deleteRefActionsCaches = async (
   repo: { owner: string; repo: string },
   ref: string
 ): Promise<void> => {
+  const isDryRun = core.getBooleanInput('dry-run')
+  const dryRunPrefix = isDryRun ? 'DRY-RUN MODE ' : ''
+
   const deleteCache = async (cache: Cache): Promise<void> => {
     if (!cache.id) return
-    core.info(`   - Cache with key ${cache.key}`)
-    await octokit.rest.actions.deleteActionsCacheById({
-      ...repo,
-      cache_id: cache.id
-    })
+    core.info(`${dryRunPrefix}   - Cache with key ${cache.key}`)
+    if (!isDryRun) {
+      await octokit.rest.actions.deleteActionsCacheById({
+        ...repo,
+        cache_id: cache.id
+      })
+    }
   }
 
   // https://github.com/octokit/plugin-paginate-rest.js#octokitpaginate
@@ -29,7 +34,7 @@ const deleteRefActionsCaches = async (
       per_page: 100
     }
   )
-  core.info(`⌛ Deleting ${caches.length} cache(s) on ${ref}`)
+  core.info(`${dryRunPrefix}⌛ Deleting ${caches.length} cache(s) on ${ref}`)
 
   await Promise.all(caches.map(async cache => deleteCache(cache)))
 }
@@ -47,7 +52,6 @@ export async function run(): Promise<void> {
     const { repo, eventName, payload } = github.context
 
     const ref = getRef({ eventName, payload })
-
     if (ref === null) {
       core.info('🤔 Could not determine deletion target.')
       core.info(
@@ -56,6 +60,7 @@ export async function run(): Promise<void> {
       return
     }
     await deleteRefActionsCaches(octokit, repo, ref)
+
     core.info('✅ Done')
   } catch (error) {
     // Fail the workflow run if an error occurs