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: false
     default: ${{ github.token }}
+  dry-run:
+    description: 'dry-run caches deletion'
+    required: false
+    default: 'false'
 
 # Define your outputs here.
 

src/main.ts

@@ -1,12 +1,22 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
+import * as v from 'valibot'
 import { getRef } from './ref'
+import { DryRunSchema } from './schema'
 
 const deleteRefActionsCaches = async (
   octokit: ReturnType<typeof github.getOctokit>,
   repo: { owner: string; repo: string },
   ref: string
 ): Promise<void> => {
+  const isDryRun = v.parse(
+    DryRunSchema,
+    core.getInput('dry-run', { trimWhitespace: true })
+  )
+  const dryRunPrefix = isDryRun ? 'DRY-RUN MODE ' : ''
+
+  core.info(`${dryRunPrefix}⌛ Deleting caches on ${ref}`)
+
   // Get the list of cache IDs
   // https://github.com/octokit/plugin-paginate-rest.js#octokitpaginate
   const iterator = octokit.paginate.iterator(
@@ -21,11 +31,13 @@ const deleteRefActionsCaches = async (
   for await (const { data: cacheList } of iterator) {
     for (const cache of cacheList) {
       if (!cache.id) continue
-      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
+        })
+      }
     }
   }
 }
@@ -43,17 +55,17 @@ 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(
         'ℹ️ If you suspect this is a bug, please consider raising an issue to help us address it promptly.'
       )
       return
     }
-    core.info(`⌛ Deleting caches on ${ref}`)
+
     await deleteRefActionsCaches(octokit, repo, ref)
-    core.info('✅ Done')
+
+    core.info(`✅ Done`)
   } catch (error) {
     // Fail the workflow run if an error occurs
     if (error instanceof Error) {

src/schema.ts

@@ -1,5 +1,9 @@
-import { nullable, optional, string } from 'valibot'
+import { boolean, coerce, nullable, optional, string } from 'valibot'
 
 export const StringSchema = string()
 export const OptionalStringSchema = optional(string())
 export const NullableStringSchema = nullable(string())
+export const DryRunSchema = coerce(
+  boolean('The dry-run option must be either "true" or "false".'),
+  input => JSON.parse(`${input}`)
+)