Rename jdkFile input to jdk-file with deprecated alias - #1083

brunoborges · 2026-07-08T15:47:38Z

Description:

jdkFile was the only action input using camelCase while every other input follows the lowercase-dash convention (java-version, check-latest, etc.). This standardizes the naming.

This adds a new jdk-file input and keeps jdkFile working as a deprecated alias:

jdk-file takes precedence when both are provided.
Using the jdkFile alias still works but emits a core.warning telling the user it is deprecated and may be removed in a future release.
The alias resolution lives in a small getJdkFileInput() helper in setup-java.ts; action.yml also carries a deprecationMessage on the jdkFile input.

Docs (README, advanced-usage, switching-to-v2) now use jdk-file. The local-file e2e workflow uses jdk-file for the Corretto and Zulu cases, and intentionally keeps the Temurin case on the jdkFile alias so the backward-compatible path stays covered. The dist/ bundles were regenerated.

Note: this only touches the input property name. The separate distribution: 'jdkfile' value is unrelated and left unchanged.

Related issue:

Fixes: #1077

Check list:

Ran npm run check locally (format, lint, build, test) and all checks pass.
Mark if documentation changes are required.
Mark if tests were added or updated to cover the changes.

Add a standardized `jdk-file` input to match the lowercase-dash naming used by every other action input. The camelCase `jdkFile` input is kept as a deprecated alias: it still works, but emits a deprecation warning and may be removed in a future release. `jdk-file` takes precedence when both are provided. Updates docs and the local-file e2e workflow (one case intentionally keeps using the deprecated alias for coverage) and regenerates the dist bundles. Fixes #1077 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Standardizes the action input name for providing a local JDK archive by introducing jdk-file (kebab-case) while keeping jdkFile working as a deprecated alias, aligning this input with the action’s existing input naming conventions.

Changes:

Added jdk-file as the primary input and kept jdkFile as a deprecated alias (with warning + precedence rules).
Updated documentation and the local-file E2E workflow to use jdk-file (while intentionally keeping one deprecated-alias path covered).
Regenerated dist/ bundles to reflect the updated runtime code.

Show a summary per file

File	Description
src/setup-java.ts	Adds `getJdkFileInput()` helper to resolve `jdk-file` vs deprecated `jdkFile` and emit a warning for deprecated usage.
src/constants.ts	Renames the primary input constant to `jdk-file` and introduces a deprecated constant for `jdkFile`.
README.md	Updates input documentation to reference `jdk-file` and notes `jdkFile` deprecation.
docs/switching-to-v2.md	Updates the local-file example to use `jdk-file` (but the example still targets `actions/setup-java@v2`).
docs/advanced-usage.md	Updates examples and narrative to use `jdk-file`.
action.yml	Adds `jdk-file` input, keeps `jdkFile` with a deprecationMessage.
.github/workflows/e2e-local-file.yml	Migrates Corretto/Zulu to `jdk-file` and keeps Temurin on deprecated `jdkFile` to ensure backward-compat coverage.
dist/setup/index.js	Updates bundled constants and input resolution logic in the compiled distribution.
dist/cleanup/index.js	Updates bundled constants in the compiled cleanup distribution.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Files reviewed: 7/9 changed files
Comments generated: 1
Review effort level: Low

The switching-to-v2 migration guide uses actions/setup-java@v2, which only supports the camelCase jdkFile input. Keep the new jdk-file spelling in current-version docs only. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

* Rename jdkFile input to jdk-file with deprecated alias Add a standardized `jdk-file` input to match the lowercase-dash naming used by every other action input. The camelCase `jdkFile` input is kept as a deprecated alias: it still works, but emits a deprecation warning and may be removed in a future release. `jdk-file` takes precedence when both are provided. Updates docs and the local-file e2e workflow (one case intentionally keeps using the deprecated alias for coverage) and regenerates the dist bundles. Fixes actions#1077 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * docs: keep jdkFile in switching-to-v2 guide The switching-to-v2 migration guide uses actions/setup-java@v2, which only supports the camelCase jdkFile input. Keep the new jdk-file spelling in current-version docs only. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> (cherry picked from commit 7dbccc6)

actions#1084) Regenerate the CommonJS bundle so the compiled dist/ reflects the source changes backported from main, without the ESM migration (actions#1078). Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings July 8, 2026 15:47

brunoborges requested a review from a team as a code owner July 8, 2026 15:47

Copilot started reviewing on behalf of brunoborges July 8, 2026 15:48 View session

brunoborges added the maintenance Internal refactors/chore work label Jul 8, 2026

brunoborges self-assigned this Jul 8, 2026

Copilot AI reviewed Jul 8, 2026

View reviewed changes

Comment thread docs/switching-to-v2.md Outdated

brunoborges merged commit 7dbccc6 into main Jul 8, 2026
406 checks passed

brunoborges deleted the brunoborges-rename-jdkfile-to-jdk-file branch July 8, 2026 16:45

Navigation Menu

Uh oh!

Rename jdkFile input to jdk-file with deprecated alias - #1083