Skip to content

V2 setup-java ADR #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
konradpabjan merged 5 commits into from
Mar 8, 2021
Merged

V2 setup-java ADR #97

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5b8e700
V2 setup-java initial ADR
konradpabjan Aug 24, 2020
c873d68
Update ADR
konradpabjan Aug 24, 2020
5a4a419
Misc fixes
konradpabjan Aug 24, 2020
bfa3ae1
Clarifications around default behavior and new input
konradpabjan Dec 2, 2020
4d60e84
PR feedback
konradpabjan Mar 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Clarifications around default behavior and new input
  • Loading branch information
@konradpabjan
konradpabjan committed Dec 2, 2020
commit bfa3ae1e2b54ff133b0b5785f508cfa6bcdef823
10 changes: 6 additions & 4 deletions docs/adrs/0000-v2-setup-java.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Status: Proposed

- Zulu and AdoptOpenJDK aren't the only distributions of Java though. Other providers include Oracle OpenJDK or Amazon Corretto and ideally it would be nice to support downloading Java from all providers.

- GitHub Actions virtual environments install and default to AdoptOpenJDK builds of OpenJDK. `setup-java` should align to the same behavior.
- GitHub Actions virtual environments install and default to AdoptOpenJDK builds of OpenJDK. `setup-java` should give users an option to donwload and use other distributions that may not be be installed

# Decision

## New input

A new input parameter (titled `distribution`) will be added to `setup-java` that will allow users to specify the distribution that they would like to download
A new required input parameter (titled `distribution`) will be added to `setup-java` that will allow users to specify the distribution that they would like to download

```yaml
with:
Expand All @@ -26,7 +26,9 @@ A new input parameter (titled `distribution`) will be added to `setup-java` that

## Default Behavior

If no `distribution` parameter is provided, the default value will be `adoptopenjdk`. The action will first attempt to use pre-installed versions of AdoptOpenJDK builds of OpenJDK on GitHub hosted runners. If a specific version is not found, the action will then download and install the correct version.
There will be no default distribution that we pick for the user. Users will have to specify a distribution in their YAML or else the action will fail.

Requiring a default version will break users that are pinned to `@master` or `@main` as they will have no `distribution` specified in their YAML. Users pinned to `v1` will be uneffected. This change is meant to not be backward compatible and it is acceptable to change the default behavior because a new major version will be released alongside these changes.

## Extensibility & Documentation

Expand Down Expand Up @@ -70,5 +72,5 @@ The `setup-java` action has some logic that creates a `settings.xml` file so tha

- Users will have more flexibility and the freedom to choose a specific distribution that they would like (AdoptOpenJDK builds of OpenJDK in addition or Zulu builds of OpenJDK)
- `setup-java` will be structured in such a way that will allow for more distributions to be easily added in the future
- A large subset of users pin to `@main` or `@master` instead of to a specific version (`v1`). By introducing a breaking change by switching from `Zulu` to `AdoptOpenJDK` as the default, certain existing workflows for users might break
- A large subset of users pin to `@main` or `@master` instead of to a specific version (`v1`). By introducing a breaking change that now requires a distribution to be specified, many users will have their workflows fail until they go and update their yaml
- Higher maintenance and support burden moving forward