feat: add dry-run option

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

__tests__/main.test.ts

@@ -18,7 +18,7 @@ const runMock = jest.spyOn(main, 'run')
 // Mock the GitHub Actions core library
 // let debugMock: jest.SpyInstance
 let errorMock: jest.SpyInstance
-let getInputMock: jest.SpyInstance
+let getBooleanInputMock: jest.SpyInstance
 // let setFailedMock: jest.SpyInstance
 // let setOutputMock: jest.SpyInstance
 
@@ -28,19 +28,21 @@ describe('action', () => {
 
     // debugMock = jest.spyOn(core, 'debug').mockImplementation()
     errorMock = jest.spyOn(core, 'error').mockImplementation()
-    getInputMock = jest.spyOn(core, 'getInput').mockImplementation()
+    getBooleanInputMock = jest
+      .spyOn(core, 'getBooleanInput')
+      .mockImplementation()
     // setFailedMock = jest.spyOn(core, 'setFailed').mockImplementation()
     // setOutputMock = jest.spyOn(core, 'setOutput').mockImplementation()
   })
 
-  it('sets the time output', async () => {
-    // Set the action's inputs as return values from core.getInput()
-    getInputMock.mockImplementation((name: string): string => {
+  it('sets the dry-run', async () => {
+    // Set the action's inputs as return values from core.getBooleanInput()
+    getBooleanInputMock.mockImplementation((name: string): boolean => {
       switch (name) {
-        case 'milliseconds':
-          return '500'
+        case 'dry-run':
+          return true
         default:
-          return ''
+          return false
       }
     })
 

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/get-inputs.ts

@@ -0,0 +1,6 @@
+import * as core from '@actions/core'
+
+export const getInputs = () => ({
+  token: core.getInput('repo-token', { required: true }),
+  dryRun: core.getBooleanInput('dry-run')
+})

src/main.ts

@@ -2,22 +2,31 @@ import * as core from '@actions/core'
 import * as github from '@actions/github'
 import { getRef } from './ref'
 import type * as types from '@octokit/openapi-types'
+import { getInputs } from './get-inputs'
 
 type Cache =
   types.components['schemas']['actions-cache-list']['actions_caches'][number]
 
+const ansi = { reset: '\x1B[0m', dryRun: '\x1B[38;2;90;185;255m' }
+
+const prefix = ({ isDryRun = false }: { isDryRun: boolean }) =>
+  isDryRun ? `${ansi.dryRun}DRY-RUN MODE ${ansi.reset}` : ''
+
 const deleteRefActionsCaches = async (
   octokit: ReturnType<typeof github.getOctokit>,
   repo: { owner: string; repo: string },
-  ref: string
+  ref: string,
+  isDryRun: boolean
 ): Promise<void> => {
   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(`${prefix({ isDryRun })}   - 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 +38,9 @@ const deleteRefActionsCaches = async (
       per_page: 100
     }
   )
-  core.info(`⌛ Deleting ${caches.length} cache(s) on ${ref}`)
+  core.info(
+    `${prefix({ isDryRun })}⌛ Deleting ${caches.length} cache(s) on ${ref}`
+  )
 
   await Promise.all(caches.map(async cache => deleteCache(cache)))
 }
@@ -40,23 +51,23 @@ const deleteRefActionsCaches = async (
  */
 export async function run(): Promise<void> {
   try {
-    const token = core.getInput('repo-token', { required: true })
+    const { token, dryRun: isDryRun } = getInputs()
     const octokit = github.getOctokit(token)
 
     // get repostiory information
     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
     }
-    await deleteRefActionsCaches(octokit, repo, ref)
-    core.info('✅ Done')
+    await deleteRefActionsCaches(octokit, repo, ref, isDryRun)
+
+    core.info(`${prefix({ isDryRun })}✅ Done`)
   } catch (error) {
     // Fail the workflow run if an error occurs
     if (error instanceof Error) {