GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — docs: correct the mvn-toolchain-id default in README and action.yml by brunoborges · Pull Request #1207 · actions/setup-java

Conversation

@brunoborges

@brunoborges brunoborges commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Description:

The generated Maven toolchain ID is ${vendor}_${version}, where vendor is the mvn-toolchain-vendor input falling back to distribution (src/toolchains.ts). Two places described this incorrectly, and they disagreed with each other:

  • action.yml claimed the default was "${distribution}_${java-version}". That is wrong whenever mvn-toolchain-vendor is set, because overriding the vendor also changes the generated ID. A user who sets a vendor and then writes a toolchain requirement against the distribution-based ID gets a toolchain that never matches.
  • README.md said ${vendor}_${java-version}. That is accurate, but vendor is not the name of any action input, so it left readers to guess where the value came from.

Both now name mvn-toolchain-vendor and state that it falls back to distribution. docs/advanced-usage.md already explained this correctly and is unchanged.

Found via a Copilot review comment on #1205, which flagged the README wording; checking it against the source showed action.yml was the more misleading of the two.

Related issue:
N/A. Follow-up to #1204.

Check list:

  • Ran npm run check locally (format, lint, build, test) and all checks pass. Not run. The change is two description strings; action.yml is metadata that is not compiled into dist/, and I verified it still parses as YAML.
  • Mark if documentation changes are required. This change is documentation only.
  • Mark if tests were added or updated to cover the changes. No behavior change.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@brunoborges
docs: correct the mvn-toolchain-id default in README and action.yml
ccb6955 
The generated toolchain ID is `${vendor}_${version}`, where vendor is the
mvn-toolchain-vendor input falling back to distribution. Two places described
this incorrectly.

action.yml claimed the default was "${distribution}_${java-version}", which
is wrong whenever mvn-toolchain-vendor is set, since overriding the vendor
also changes the generated ID.

The README used `${vendor}`, which is accurate but names something that is
not an action input, leaving readers to guess where the value comes from.

Both now name mvn-toolchain-vendor and state that it falls back to
distribution.

Co-authored-by: Copilot App <[email protected]>
Copilot-Session: 664777db-7250-417d-b94d-d5529ec3fec2
@brunoborges
brunoborges requested a review from a team as a code owner August 5, 2026 03:26
Copilot AI lite review requested due to automatic review settings August 5, 2026 03:26
Copilot started reviewing on behalf of brunoborges August 5, 2026 03:27
View session
Copilot AI reviewed Aug 5, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes and aligns the documentation for how setup-java derives the default Maven toolchain id, matching the actual implementation in src/toolchains.ts (default id is ${vendor}_${version}, where vendor comes from the mvn-toolchain-vendor input and falls back to distribution).

Changes:

  • Update README.md to name the mvn-toolchain-vendor input explicitly in the default toolchain ID description.
  • Update action.yml’s mvn-toolchain-id input description to reflect the correct default ID format and note the vendor fallback to distribution.
Show a summary per file
File Description
README.md Clarifies the default Maven toolchain ID template by referencing mvn-toolchain-vendor explicitly.
action.yml Corrects the mvn-toolchain-id input description to match the real default ID derivation and vendor fallback behavior.

Review details

Tip

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

  • Files reviewed: 2/2 changed files
  • Comments generated: 0
  • Review effort level: Lite

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@brunoborges
Merge branch 'main' into fix-toolchain-id-default
4dbfbba
@brunoborges
brunoborges merged commit ef9440a into actions:main Aug 5, 2026
55 checks passed

Uh oh!

There was an error while loading. Please reload this page.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@brunoborges
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.