Centralize OS/architecture capability validation - #1178
Merged
brunoborges merged 3 commits intoJul 29, 2026
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 10e35b75-928f-4ef7-984e-605895c5d88e
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request centralizes OS/architecture capability validation for Java distributions, normalizes architecture aliases consistently, and updates installers/tests/docs so unsupported platform combinations fail early (before cache lookup or network calls).
Changes:
- Added a shared platform capability contract + normalization/validation helpers (src/distributions/platform-types.ts).
- Updated distribution factory and base installer plumbing to validate + pass normalized architectures downstream, with vendor-specific translations handled in per-distribution installers.
- Added/updated contract tests, distribution/factory tests, docs/action input text, and an E2E workflow assertion for an unsupported combination.
| File | Description |
|---|---|
| src/distributions/platform-types.ts | Introduces shared platform capability matrices, arch alias normalization, and centralized validation logic. |
| src/distributions/distribution-factory.ts | Validates package + platform earlier and passes normalized architecture into installer construction. |
| src/distributions/base-installer.ts | Normalizes architecture at the base level and simplifies default distribution architecture mapping. |
| src/distributions/adopt/installer.ts | Translates canonical armv7 to vendor arm. |
| src/distributions/temurin/installer.ts | Translates canonical armv7 to vendor arm. |
| src/distributions/corretto/installer.ts | Translates canonical armv7 to vendor arm. |
| src/distributions/zulu/installer.ts | Extends vendor mapping to translate canonical armv7 to vendor arm. |
| tests/java-platform-contract.test.ts | Adds contract tests to keep capability tables aligned with docs and consistent diagnostics. |
| tests/distributors/distribution-factory.test.ts | Updates factory tests to reflect platform validation and normalized architecture behavior. |
| tests/distributors/adopt-installer.test.ts | Updates normalization expectations for ARM-related cases. |
| tests/distributors/temurin-installer.test.ts | Updates normalization expectations for ARM-related cases. |
| tests/distributors/corretto-installer.test.ts | Adds coverage ensuring canonical vs vendor architecture values remain distinct. |
| docs/advanced-usage.md | Documents the up-front platform/architecture compatibility matrix and validation behavior. |
| README.md | Updates architecture input documentation and alias normalization description. |
| action.yml | Updates the architecture input description to reflect canonical values + aliases. |
| .github/workflows/e2e-versions.yml | Adds an E2E assertion that an unsupported combination is rejected. |
| dist/setup/index.js | Rebuilt bundled output to include the new platform validation logic. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/distributions/platform-types.ts:112
- The semver range "<=11" only matches up to 11.0.0, so it would incorrectly reject Windows x86 for 11.x patch releases. Use "<12" to represent "Java 11 or earlier".
windows: ['x64', {architecture: 'x86', versionRange: '<=11'}]
src/distributions/platform-types.ts:45
- The semver range "<=17" only matches up to 17.0.0, so it would incorrectly reject common 17.x patch releases (e.g., 17.0.10). Use "<18" to include all 17.* versions.
linux: [...STANDARD_LINUX, {architecture: 'armv7', versionRange: '<=17'}],
src/distributions/platform-types.ts:59
- The semver range "<=17" only matches up to 17.0.0, so it would incorrectly reject common 17.x patch releases even though the intent is "through Java 17". Use "<18" to include all 17.* versions.
linux: [...STANDARD_LINUX, {architecture: 'armv7', versionRange: '<=17'}],
src/distributions/platform-types.ts:230
- Checking only for the presence of the "unrestricted" property can misclassify a restricted capability if it ever sets unrestricted: false explicitly (the type allows that). Check that the value is actually true before skipping platform validation.
const capability = JAVA_PLATFORM_CAPABILITIES[distributionName];
if ('unrestricted' in capability) {
return normalizedArchitecture;
}
- Files reviewed: 16/17 changed files
- Comments generated: 5
- Review effort level: Low
Sorry, something went wrong.
Comment thread
src/distributions/platform-types.ts
Outdated
Comment thread
src/distributions/platform-types.ts
Outdated
Comment thread
__tests__/distributors/distribution-factory.test.ts
Outdated
Comment thread
__tests__/java-platform-contract.test.ts
Comment thread
__tests__/java-platform-contract.test.ts
Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 10e35b75-928f-4ef7-984e-605895c5d88e
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This makes platform compatibility checks deterministic and consistent across distributions, so unsupported OS/architecture requests fail before cache lookup or vendor network calls. It addresses drift risk by moving capability rules into a shared contract that tests and docs can validate.
What changed
Notes
Fixes: #1176