Update .gitpod.yml to use Java 21 by default #373

SohamJuneja · 2024-12-25T20:29:09Z

Fixes #367

Testing done

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests - that demonstrates feature works or fixes the issue

krisstern

Also, has any testing been done with this setup?

.gitpod.yml

SohamJuneja · 2024-12-26T12:13:23Z

I applied desired changes but now getting a new error:
[ERROR] Failed to execute goal com.github.eirslett:frontend-maven-plugin:1.15.1:install-node-and-npm (install node and npm) on project design-library: Could not install Node: Could not find the downloaded Node.js binary in /workspace/design-library-plugin/node/tmp/node-v20.18.1-linux-x64/bin/node -> [Help 1]

I dont think that this error is just because of updation in gitpod.yml file but still trying to find what am I missing here.

After this error , when I use java -version it gives me the correct version :
openjdk version "21.0.4" 2024-07-16 LTS
which means that Java21 was installed successfully.

krisstern · 2024-12-26T12:36:06Z

One quick fix is to revert change to add back curl -s "https://get.sdkman.io" | bash since my question was intended as a check but not necessary a request for change so you may want to keep it if it works that way.

If reverting does not work then maybe (I am not 100% sure unless we have tried) we should try to config the dependencies we will need using a custom Dockerfile called .gitpod.Dockerfile? From the look of things we will need at least both Java (https://www.gitpod.io/docs/introduction/languages/java) and JavaScript (https://www.gitpod.io/docs/introduction/languages/javascript).

SohamJuneja · 2024-12-26T13:52:12Z

Yes, even after reverting the change and adding the curl back, I’m still encountering the same error. The error seems to persist regardless of the changes, and I am unable to pinpoint the exact cause. I have checked that Java 21 was successfully installed, as confirmed by the java -version output. I still suspect that the issue might not be entirely related to the recent changes in the gitpod.yml file, but I'm continuing to investigate

krisstern · 2024-12-26T13:52:30Z

As mentioned in #374 (comment) @timja prefers to use Dockerfile for the Gitpod configuration. Would you be willing to adapt this PR with that change in mind?

krisstern · 2024-12-26T13:59:23Z

Regarding your bug, you may want to add the required dependencies via both Java (https://www.gitpod.io/docs/introduction/languages/java) and JavaScript (https://www.gitpod.io/docs/introduction/languages/javascript using a Dockerfile instead.

krisstern · 2024-12-26T14:12:07Z

In case you are not aware of already the Node.js referred to in

[ERROR] Failed to execute goal com.github.eirslett:frontend-maven-plugin:1.15.1:install-node-and-npm (install node and npm) on project design-library: Could not install Node: Could not find the downloaded Node.js binary in /workspace/design-library-plugin/node/tmp/node-v20.18.1-linux-x64/bin/node -> [Help 1]

is not a Java dependency but a JavaScript dependency.

krisstern · 2024-12-26T14:28:14Z

.gitpod.yml

-  - init: mvn install -P quick-build
+  - init: |
+      curl -s "https://get.sdkman.io" | bash
+      echo "sdkman_auto_answer=true" > $HOME/.sdkman/etc/config


Just curious, is this line L4:

echo "sdkman_auto_answer=true" > $HOME/.sdkman/etc/config

really necessary?

Yes, that line is necessary because without it, it prompts you to confirm whether you want to use Java 21 as the default version. By setting sdkman_auto_answer=true, it automatically answers "yes" to this prompt, making the setup seamless without requiring manual input.

SohamJuneja · 2024-12-26T15:05:31Z

In case you are not aware of already the Node.js referred to in

[ERROR] Failed to execute goal com.github.eirslett:frontend-maven-plugin:1.15.1:install-node-and-npm (install node and npm) on project design-library: Could not install Node: Could not find the downloaded Node.js binary in /workspace/design-library-plugin/node/tmp/node-v20.18.1-linux-x64/bin/node -> [Help 1]

is not a Java dependency but a JavaScript dependency.

Yes , I'm aware of that

SohamJuneja · 2024-12-26T15:16:59Z

As mentioned in #374 (comment) @timja prefers to use Dockerfile for the Gitpod configuration. Would you be willing to adapt this PR with that change in mind?

Yes, I’ve started adapting the PR to use a Dockerfile for the Gitpod configuration, as mentioned in #374.

timja

Please follow https://www.gitpod.io/guides/custom-java-distribution-on-gitpod

The dockerfile approach looks to be the best

SohamJuneja · 2024-12-26T17:20:06Z

Added a dockerfile , still the same error is coming:
[ERROR] Failed to execute goal com.github.eirslett:frontend-maven-plugin:1.15.1:install-node-and-npm (install node and npm) on project design-library: Could not extract the Node archive: Could not extract archive: '/workspace/m2-repository/com/github/eirslett/node/20.18.1/node-20.18.1-linux-x64.tar.gz'
Trying to resolve this now ( both node.js and java versions are installed correctly ) , installed 20.18.1 as it was referenced in this error multiple times.

krisstern · 2024-12-26T17:37:56Z

May I ask how are you testing your new Gitpod environment? Could you provide some details about the steps you have taken?

SohamJuneja · 2024-12-26T17:49:20Z

I’ve been testing the new Gitpod environment by configuring the Dockerfile to install the required versions of Java and Node.js, and adjusting the gitpod.yml file to use it. During the process, I ran into some issues that required trial and error, so I created a separate branch in my fork to test all the changes before merging them. I hope this isn’t considered a bad practice, but it helped ensure everything works as expected.

krisstern · 2024-12-26T18:13:37Z

I’ve been testing the new Gitpod environment by configuring the Dockerfile to install the required versions of Java and Node.js, and adjusting the gitpod.yml file to use it. During the process, I ran into some issues that required trial and error, so I created a separate branch in my fork to test all the changes before merging them. I hope this isn’t considered a bad practice, but it helped ensure everything works as expected.

But how do you run the tests on Gitpod locally?

SohamJuneja · 2024-12-26T18:27:23Z

To test the changes, I made modifications to the files locally and then pushed the changes to my branch. After that, I opened the branch directly in Gitpod, which automatically triggered the build process. During the build, all dependencies were installed at the start, and that’s when I encountered the error in the terminal.

krisstern · 2024-12-26T19:06:20Z

I see, let me see if I can reproduce your issues

krisstern · 2024-12-26T19:23:37Z

I have tweaked your code a bit in https://github.com/krisstern/design-library-plugin/tree/java21bydefault and have run everything again but I did not encounter any failures or errors. In fact, the following is what I see:

gp tasks attach 5fc6e2e1-1fbf-4a0d-bc8d-7dccf606b092
gitpod /workspace/design-library-plugin (java21bydefault) $ gp tasks attach 5fc6e2e1-1fbf-4a0d-bc8d-7dccf606b092
 HISTFILE=/workspace/.gitpod/cmd-1 history -r; {
gp ports await 8080 && gp url 8080 && gp preview $(gp url 8080)/jenkins/
}
gitpod /workspace/design-library-plugin (java21bydefault) $  HISTFILE=/workspace/.gitpod/cmd-1 history -r; {
> gp ports await 8080 && gp url 8080 && gp preview $(gp url 8080)/jenkins/
> }
Awaiting port 8080... ok
https://8080-krisstern-designlibrary-msaey2xybvr.ws-us117.gitpod.io
gitpod /workspace/design-library-plugin (java21bydefault) $ java --version
Picked up JAVA_TOOL_OPTIONS: -XX:+UseContainerSupport -XX:ActiveProcessorCount=1
openjdk 21.0.4 2024-07-16 LTS
OpenJDK Runtime Environment Temurin-21.0.4+7 (build 21.0.4+7-LTS)
OpenJDK 64-Bit Server VM Temurin-21.0.4+7 (build 21.0.4+7-LTS, mixed mode, sharing)
gitpod /workspace/design-library-plugin (java21bydefault) $ node --version
v20.18.1

The below is what I see in my browser:

krisstern · 2024-12-26T19:25:24Z

The only major difference is that the .gitpod/Dockerfile I have is as follows:

FROM gitpod/workspace-full

ARG MAVEN_VERSION=3.9.9
ARG NODE_VERSION=20.18.1

# Install Java 21.0.4-tem and Node.js v20.18.1
RUN brew install gh && \
    bash -c ". /home/gitpod/.sdkman/bin/sdkman-init.sh && sdk install maven ${MAVEN_VERSION} && sdk default maven ${MAVEN_VERSION} && \
    sdk install java 21.0.4-tem && \
    sdk default java 21.0.4-tem" && \
    bash -c "source $HOME/.nvm/nvm.sh && nvm install ${NODE_VERSION} \
    && nvm use ${NODE_VERSION} && nvm alias default ${NODE_VERSION}"

# Ensure nvm uses the default version on every new terminal session
RUN echo "nvm use default &>/dev/null" >> ~/.bashrc.d/51-nvm-fix

krisstern · 2024-12-26T19:32:08Z

But I will have to admit I may not need to have "mvn" installed... so you may want to clean that up a bit

krisstern · 2024-12-26T19:34:13Z

And you may also want to set the Java JDK version as an ARG variable as well.

SohamJuneja · 2024-12-27T08:25:00Z

@krisstern Thanks for the updates. I suspected there might be a configuration issue in my VS Code in gitpod, so I switched to IntelliJ IDEA, and it worked. Now, both your updates and my approach are running without errors. Could you let me know which one you think we should proceed with for the final code?

krisstern · 2024-12-27T08:28:27Z

Yeah, for VSCode you will need to configure something additional like the devcontainer.json file to make things work, and I was using IntelliJ myself.

krisstern

For the .gitpod/Dockerfile file, can we use ARG for both the Java JDK version and the Node.js version?

SohamJuneja · 2024-12-27T08:33:05Z

Sure , updating the Dockerfile with the latest node version ( earlier it was 20.18.1 )

krisstern · 2024-12-27T08:38:30Z

.gitpod/Dockerfile

@@ -0,0 +1,19 @@
+FROM gitpod/workspace-full:latest
+
+USER gitpod


I am wondering what is this for and do we really need this? I tried without this config and everything worked as expected.

They are used to specify a base image but ig Gitpod already uses these settings by default, so they can be removed without issue.

I think we can run as root (user) by default, since we are using Gitpod this would not be too risky

Yes , right . I am removing both of these lines and will check again on gitpod just for surity.

Wait, I meant for the USER gitpod line only

I think they have some formatting issue on GitHub, so if I comment on a line plesae only pay attention to the last line. This is a known issue with GitHub.

krisstern · 2024-12-27T08:48:04Z

.gitpod/Dockerfile

@@ -1,7 +1,3 @@
-FROM gitpod/workspace-full:latest


Please add this line back

Yes , even I ran without this and faced some error to load with default image only , adding it back .

SohamJuneja · 2024-12-27T09:01:20Z

I've tested the changes, and everything is working fine now. Please let me know if any further modifications are needed

krisstern

@SohamJuneja Just tested your branch on Gitpod and it worked. Thanks for all the hard work put into this PR!

SohamJuneja · 2024-12-27T09:07:51Z

Thanks a lot for your guidance too! @krisstern @timja

timja

Thanks!

SohamJuneja added 2 commits December 26, 2024 01:48

Update .gitpod.yml

83745b6

Update .gitpod.yml

8091c7d

SohamJuneja requested a review from a team as a code owner December 25, 2024 20:29

krisstern mentioned this pull request Dec 26, 2024

Updated gitpod to use Java 21 #374

Closed

6 tasks

krisstern requested changes Dec 26, 2024

View reviewed changes

.gitpod.yml Outdated Show resolved Hide resolved

.gitpod.yml Outdated Show resolved Hide resolved

.gitpod.yml Outdated Show resolved Hide resolved

krisstern changed the title ~~Update .gitpod.yml to use java 21 by default~~ Update .gitpod.yml to use Java 21 by default Dec 26, 2024

krisstern reviewed Dec 26, 2024

View reviewed changes

.gitpod.yml Outdated Show resolved Hide resolved

Update .gitpod.yml

aa921d2

Update .gitpod.yml

141a6a4

krisstern reviewed Dec 26, 2024

View reviewed changes

timja reviewed Dec 26, 2024

View reviewed changes

Implemented docker based installation

b5e6c69

krisstern requested changes Dec 27, 2024

View reviewed changes

Update Dockerfile with latest version and ARG

12a685e

krisstern reviewed Dec 27, 2024

View reviewed changes

krisstern requested review from timja and krisstern December 27, 2024 08:39

Remove unnecessary base image configuration and root user setup

891c7cb

krisstern reviewed Dec 27, 2024

View reviewed changes

Re-added the line to use the latest Gitpod workspace image

4b0b95f

krisstern approved these changes Dec 27, 2024

View reviewed changes

timja approved these changes Dec 27, 2024

View reviewed changes

timja merged commit fcccabb into jenkinsci:master Dec 27, 2024
17 checks passed

timja added the dependencies label Dec 27, 2024

SohamJuneja deleted the java21bydefault branch December 28, 2024 08:17

		@@ -0,0 +1,19 @@
		FROM gitpod/workspace-full:latest

		USER gitpod

Update .gitpod.yml to use Java 21 by default #373

Update .gitpod.yml to use Java 21 by default #373

Conversation

SohamJuneja commented Dec 25, 2024 • edited by krisstern Loading

Testing done

Submitter checklist

krisstern left a comment

Choose a reason for hiding this comment

SohamJuneja commented Dec 26, 2024 • edited Loading

krisstern commented Dec 26, 2024

SohamJuneja commented Dec 26, 2024

krisstern commented Dec 26, 2024

krisstern commented Dec 26, 2024

krisstern commented Dec 26, 2024

krisstern Dec 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SohamJuneja commented Dec 26, 2024

SohamJuneja commented Dec 26, 2024

timja left a comment

Choose a reason for hiding this comment

SohamJuneja commented Dec 26, 2024

krisstern commented Dec 26, 2024

SohamJuneja commented Dec 26, 2024

krisstern commented Dec 26, 2024

SohamJuneja commented Dec 26, 2024

krisstern commented Dec 26, 2024

krisstern commented Dec 26, 2024

krisstern commented Dec 26, 2024

krisstern commented Dec 26, 2024

krisstern commented Dec 26, 2024

SohamJuneja commented Dec 27, 2024

krisstern commented Dec 27, 2024

krisstern left a comment

Choose a reason for hiding this comment

SohamJuneja commented Dec 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SohamJuneja commented Dec 27, 2024

krisstern left a comment

Choose a reason for hiding this comment

SohamJuneja commented Dec 27, 2024

timja left a comment

Choose a reason for hiding this comment

SohamJuneja commented Dec 25, 2024 •

edited by krisstern

Loading

SohamJuneja commented Dec 26, 2024 •

edited

Loading

krisstern Dec 26, 2024 •

edited

Loading

SohamJuneja commented Dec 27, 2024 •

edited

Loading