From ccb6955be219b81ee46a7945911d2c97458c276d Mon Sep 17 00:00:00 2001 From: Bruno Borges Date: Tue, 4 Aug 2026 23:26:33 -0400 Subject: [PATCH] docs: correct the mvn-toolchain-id default in README and action.yml 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 <223556219+Copilot@users.noreply.github.com> Copilot-Session: 664777db-7250-417d-b94d-d5529ec3fec2 --- README.md | 2 +- action.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5d5c6b964..563a21e39 100644 --- a/README.md +++ b/README.md @@ -174,7 +174,7 @@ steps: | `overwrite-settings` | Overwrite an existing `settings.xml`. | `true` | | `gpg-private-key` | GPG private key to import. | | | `gpg-passphrase-env-var` | Environment variable name for the GPG private key passphrase. | `GPG_PASSPHRASE` when a key is set | -| `mvn-toolchain-id` | Maven Toolchain ID. When multiple Java versions are installed, the number of IDs must match the number of versions. | `${vendor}_${java-version}` | +| `mvn-toolchain-id` | Maven Toolchain ID. When multiple Java versions are installed, the number of IDs must match the number of versions. | `${mvn-toolchain-vendor}_${java-version}` | | `mvn-toolchain-vendor` | Maven Toolchain vendor value. | `${distribution}` | | `show-download-progress` | Keep Maven artifact download and transfer progress in logs. When `false`, the action adds `-ntp` to `MAVEN_ARGS`. | `false` | diff --git a/action.yml b/action.yml index 6146f2c94..d27c23aca 100644 --- a/action.yml +++ b/action.yml @@ -106,7 +106,7 @@ inputs: required: false default: ${{ github.server_url == 'https://github.com' && github.token || '' }} mvn-toolchain-id: - description: 'Name of Maven Toolchain ID if the default name of "${distribution}_${java-version}" is not wanted. When supplied, the number of IDs must match the number of Java versions. See examples of supported syntax in Advanced Usage file' + description: 'Name of Maven Toolchain ID if the default name of "${mvn-toolchain-vendor}_${java-version}" is not wanted. The toolchain vendor defaults to the "distribution" input. When supplied, the number of IDs must match the number of Java versions. See examples of supported syntax in Advanced Usage file' required: false mvn-toolchain-vendor: description: 'Name of Maven Toolchain Vendor if the default name of "${distribution}" is not wanted. See examples of supported syntax in Advanced Usage file'