Action interface cleanup: deprecate inputs, add cache-hit output, fix extra-args (#110)

shaanmajid · web-flow · commit 7774ba80450e · 2026-03-18T14:32:15.000+08:00
## Summary

- Add `deprecationMessage` to `extra_args` and `token` inputs so GitHub
renders deprecation warnings in the workflow UI
- Change `token` default from `${{ github.token }}` to `''` to avoid
unnecessary token injection
- Add `cache-hit` output reporting whether the restored cache exactly
matched the primary key
- Fix `extra-args: ''` being impossible to express — the `||` fallback
now relies on the YAML default rather than a hardcoded `'--all-files'`
- Remove dead `_token` parameter from `resolveVersion` and `token` from
the `Inputs` type
diff --git a/README.md b/README.md
@@ -41,13 +41,14 @@ For a stable reference, pin to a specific release tag such as `v1.2.3`, or pin t
 | `prek-version` | Version or semver range to install, for example `0.2.30`, `0.3.x`, `<=1.0.0`, or `latest` | No | `latest` |
 | `working-directory` | Directory where `prek run` is executed | No | `.` |
 | `show-verbose-logs` | Print the `prek` verbose log after `prek run` completes | No | `true` |
-| `token` | Unused; retained for backward compatibility | No | `${{ github.token }}` |
+| `token` | Deprecated and unused; retained for backward compatibility | No | `''` |
 
 ## Outputs
 
 | Output | Description |
 | --- | --- |
 | `prek-version` | The resolved `prek` version, normalized to a `v`-prefixed tag |
+| `cache-hit` | Whether the restored prek cache exactly matched the computed primary cache key |
 
 ## Examples
 
diff --git a/action.yaml b/action.yaml
@@ -4,33 +4,37 @@ inputs:
   extra-args:
     description: Extra options to pass to `prek run`, appended after `--show-diff-on-failure --color=always`
     required: false
-    default: '--all-files'
+    default: "--all-files"
   extra_args:
     description: Options to pass to `prek run` (deprecated, use extra-args)
+    deprecationMessage: The extra_args input has been renamed to extra-args. Update your workflow.
     required: false
   install-only:
     description: Only install prek, do not run it
     required: false
-    default: 'false'
+    default: "false"
   prek-version:
     description: Version or semver range of prek to install (for example `0.2.1`, `0.3.x`, `<=1.0.0`, or `latest`)
     required: false
-    default: 'latest'
+    default: "latest"
   show-verbose-logs:
     description: Whether to print the prek verbose log after `prek run`
     required: false
-    default: 'true'
+    default: "true"
   working-directory:
     description: The working directory to run prek in
     required: false
-    default: '.'
+    default: "."
   token:
     description: Unused; retained for backward compatibility
+    deprecationMessage: The token input is unused and will be removed in a future major version.
     required: false
-    default: ${{ github.token }}
+    default: ""
 outputs:
   prek-version:
     description: The version of prek that was installed
+  cache-hit:
+    description: Whether the prek environment cache was an exact match
 runs:
   using: node24
   main: dist/index.cjs
diff --git a/dist/index.cjs b/dist/index.cjs
diff --git a/src/cache.ts b/src/cache.ts
@@ -12,11 +12,16 @@ import {
   PREK_CACHE_KEY_PREFIX,
 } from './types'
 
+export type RestorePrekCacheResult = {
+  matchedKey?: string
+  primaryKey: string
+}
+
 function formatError(error: unknown): string {
   return error instanceof Error ? error.message : String(error)
 }
 
-export async function restorePrekCache(workingDirectory: string): Promise<void> {
+export async function restorePrekCache(workingDirectory: string): Promise<RestorePrekCacheResult> {
   core.startGroup('Restore prek cache')
 
   const cacheDir = await getPrekCacheDir()
@@ -25,11 +30,13 @@ export async function restorePrekCache(workingDirectory: string): Promise<void>
   core.saveState(CACHE_KEY_STATE, primaryKey)
   core.saveState(CACHE_PATHS_STATE, JSON.stringify(paths))
 
+  let matchedKey: string | undefined
   try {
     const restoredKey = await cache.restoreCache(paths, primaryKey)
     if (restoredKey) {
       core.info(`Restored prek cache with key ${restoredKey}`)
       core.saveState(CACHE_MATCHED_KEY_STATE, restoredKey)
+      matchedKey = restoredKey
     } else {
       core.info(`No cache found for key ${primaryKey}`)
     }
@@ -38,6 +45,8 @@ export async function restorePrekCache(workingDirectory: string): Promise<void>
   } finally {
     core.endGroup()
   }
+
+  return { matchedKey, primaryKey }
 }
 
 export async function savePrekCache(): Promise<void> {
diff --git a/src/inputs.ts b/src/inputs.ts
@@ -3,13 +3,15 @@ import type { Inputs } from './types'
 
 // Parse and normalize action inputs, including the legacy `extra_args` alias.
 export function getInputs(): Inputs {
+  const legacyExtraArgs = core.getInput('extra_args')
+  const modernExtraArgs = core.getInput('extra-args')
   const showVerboseLogsInput = core.getInput('show-verbose-logs')
+
   return {
-    extraArgs: core.getInput('extra_args') || core.getInput('extra-args') || '--all-files',
+    extraArgs: legacyExtraArgs || modernExtraArgs,
     installOnly: core.getBooleanInput('install-only'),
     prekVersion: core.getInput('prek-version') || 'latest',
     showVerboseLogs: showVerboseLogsInput === '' ? true : core.getBooleanInput('show-verbose-logs'),
-    token: core.getInput('token'),
     workingDirectory: core.getInput('working-directory') || '.',
   }
 }
diff --git a/src/main.ts b/src/main.ts
@@ -5,17 +5,18 @@ import { installPrek } from './install'
 import { normalizeVersion, resolveVersion } from './manifest'
 import { pruneCache, runPrek, showVerboseLogs } from './prek'
 
-async function run(): Promise<void> {
+export async function run(): Promise<void> {
   const inputs = getInputs()
 
   core.startGroup('Resolving prek version')
-  const version = await resolveVersion(inputs.prekVersion, inputs.token)
+  const version = await resolveVersion(inputs.prekVersion)
   core.info(`Using prek ${version}`)
   core.endGroup()
   core.setOutput('prek-version', normalizeVersion(version))
 
   await installPrek(version)
-  await restorePrekCache(inputs.workingDirectory)
+  const { matchedKey, primaryKey } = await restorePrekCache(inputs.workingDirectory)
+  core.setOutput('cache-hit', String(matchedKey === primaryKey))
 
   if (inputs.installOnly) {
     core.info('Skipping prek run because install-only=true')
@@ -39,6 +40,12 @@ async function run(): Promise<void> {
   }
 }
 
-run().catch(error => {
-  core.setFailed(error instanceof Error ? error.message : String(error))
-})
+function isMainModule(): boolean {
+  return typeof require !== 'undefined' && typeof module !== 'undefined' && require.main === module
+}
+
+if (isMainModule()) {
+  void run().catch(error => {
+    core.setFailed(error instanceof Error ? error.message : String(error))
+  })
+}
diff --git a/src/manifest.ts b/src/manifest.ts
@@ -12,7 +12,7 @@ let versionManifestPromise: Promise<VersionManifest> | undefined
 
 // Resolve user input to a bare version. Exact versions pass through directly; ranges and `latest`
 // are resolved from the downloaded version manifest.
-export async function resolveVersion(versionInput: string, _token: string): Promise<Version> {
+export async function resolveVersion(versionInput: string): Promise<Version> {
   const normalizedInput = versionInput.trim() || 'latest'
   const exactVersion = semver.valid(toVersion(normalizedInput))
   if (exactVersion) {
diff --git a/src/types.ts b/src/types.ts
@@ -11,7 +11,6 @@ export type Inputs = {
   installOnly: boolean
   prekVersion: string
   showVerboseLogs: boolean
-  token: string
   workingDirectory: string
 }
 
diff --git a/test/inputs.test.ts b/test/inputs.test.ts
@@ -0,0 +1,86 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+
+const mockContext = vi.hoisted(() => ({
+  inputs: {} as Record<string, string>,
+  warnings: [] as string[],
+}))
+
+const toolkitMocks = vi.hoisted(() => ({
+  getBooleanInput: vi.fn((name: string) => (mockContext.inputs[name] ?? '') === 'true'),
+  getInput: vi.fn((name: string) => mockContext.inputs[name] ?? ''),
+  warning: vi.fn((message: string) => {
+    mockContext.warnings.push(message)
+  }),
+}))
+
+vi.mock('@actions/core', () => ({
+  getBooleanInput: toolkitMocks.getBooleanInput,
+  getInput: toolkitMocks.getInput,
+  warning: toolkitMocks.warning,
+}))
+
+async function importInputsModule() {
+  vi.resetModules()
+  return import('../src/inputs')
+}
+
+describe('getInputs', () => {
+  beforeEach(() => {
+    vi.resetModules()
+    vi.clearAllMocks()
+    mockContext.inputs = {}
+    mockContext.warnings = []
+  })
+
+  it('uses the configured extra-args default when no explicit value is provided', async () => {
+    mockContext.inputs['extra-args'] = '--all-files'
+
+    const { getInputs } = await importInputsModule()
+
+    expect(getInputs().extraArgs).toBe('--all-files')
+  })
+
+  it('does not emit a runtime warning for extra_args (deprecationMessage handles it)', async () => {
+    mockContext.inputs.extra_args = '--files foo.py'
+
+    const { getInputs } = await importInputsModule()
+
+    expect(getInputs().extraArgs).toBe('--files foo.py')
+    expect(mockContext.warnings).toEqual([])
+  })
+
+  it('preserves an explicit empty extra-args value', async () => {
+    mockContext.inputs['extra-args'] = ''
+
+    const { getInputs } = await importInputsModule()
+
+    expect(getInputs().extraArgs).toBe('')
+  })
+
+  it('prefers extra_args over extra-args when both are set', async () => {
+    mockContext.inputs.extra_args = '--legacy'
+    mockContext.inputs['extra-args'] = '--modern'
+
+    const { getInputs } = await importInputsModule()
+
+    expect(getInputs().extraArgs).toBe('--legacy')
+  })
+
+  it('does not expose the deprecated token value to runtime code', async () => {
+    mockContext.inputs.token = 'secret'
+
+    const { getInputs } = await importInputsModule()
+    const inputs = getInputs() as Record<string, unknown>
+
+    expect('token' in inputs).toBe(false)
+  })
+
+  it('enables verbose logs by default and allows opting out', async () => {
+    let { getInputs } = await importInputsModule()
+    expect(getInputs().showVerboseLogs).toBe(true)
+
+    mockContext.inputs['show-verbose-logs'] = 'false'
+    ;({ getInputs } = await importInputsModule())
+    expect(getInputs().showVerboseLogs).toBe(false)
+  })
+})
diff --git a/test/main.test.ts b/test/main.test.ts
diff --git a/test/manifest.test.ts b/test/manifest.test.ts
diff --git a/test/metadata.test.ts b/test/metadata.test.ts

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@ export type Inputs = {`
`11`	`11`	`installOnly: boolean`
`12`	`12`	`prekVersion: string`
`13`	`13`	`showVerboseLogs: boolean`
`14`		`- token: string`
`15`	`14`	`workingDirectory: string`
`16`	`15`	`}`
`17`	`16`