Gitpodify Jenkins Projects

Nancy-Chauhan · May 10, 2022, 3:32am

Hey Team!

I am evaluating Gitpod with Java open source projects since recently Gitpod has been integrated with JetBrains (Gitpod x JetBrains join forces to solve 'works on my machine' problem) to bring remote development to developers around the world. We can run an instance of our favourite JetBrains IDE on the Gitpod developer environment.

I want to evaluate setting up a few open-source java projects like Jenkins on Gitpod.

So that it is easier for a new contributor or existing one to start with development without getting into the hassle of setting up the local environment.
It will help pair remotely.
It can be accessible to a broader audience because it won’t require a powerful machine. Everything will be run on Gitpod’s developer environment. (When I was doing GSoC, I had an old laptop that struggled to run multiple docker containers and IDEs as it had low configurations. I remember how much I had to struggle. )

Once I can run, will it be okay if I add the “Open in Gitpod” link like it has been done in the project:

GitHub - awspring/spring-cloud-aws: The New Home for Spring Cloud AWS

Nancy-Chauhan · May 10, 2022, 3:33am

We will be able to open Jenkins repositories by simply clicking on the following button.

halkeye · May 10, 2022, 6:09am

I know docs team has been recommending gitpod for GitHub - jenkins-infra/jenkins.io: A static site for the Jenkins automation server for a while now.

Nobody owns every repo, did you have a specific project/repo in mind?

Nancy-Chauhan · May 10, 2022, 6:44am

Hey @halkeye, We can start with the project you have recommended, and also, we can Gitpodify GitHub - jenkinsci/jenkins: Jenkins automation server project. Later we can move to various plugins. The idea is to evaluate many projects

timja · May 10, 2022, 7:43am

Hi @Nancy-Chauhan

I did some work on this in the weekend, I got it somewhat working:

github.com

timja/jenkins/blob/b277277379722a1c8bdbdc61f675817c2bb89f27/.gitpod.yml

# This configuration file was automatically generated by Gitpod.
# Please adjust to your needs (see https://www.gitpod.io/docs/config-gitpod-file)
# and commit this file to your remote git repository to share the goodness with others.

tasks:
  - init: mvn install -P quick-build
  - command: mvn -pl war jetty:run

ports:
  - port: 8080
    onOpen: open-browser

github:
  prebuilds:
    pullRequestsFromForks: true

image:
  file: '.gitpod.Dockerfile'

github.com

timja/jenkins/blob/b277277379722a1c8bdbdc61f675817c2bb89f27/.gitpod.Dockerfile

FROM gitpod/workspace-full

RUN bash -c ". /home/gitpod/.sdkman/bin/sdkman-init.sh && sdk install maven 3.8.4 && sdk default maven 3.8.4"

In the test instance forms don’t submit due to the URL forwarding, I think it needs some more configuration, Jenkins tries to redirect you to http://localhost:8080 instead of the git pod address.

If you want to finish that off it would be great!

timja · May 10, 2022, 7:45am

One thing I haven’t figured out is how to get the test URL when using a Jetbrains IDE.

If I open it in VS Code in the browser I get a notification prompting me to open the test instance.

I don’t seem to get the same notification in IntelliJ

(when I was testing I just opened it VS code browser to get the url but not the best)

Nancy-Chauhan · May 11, 2022, 9:34am

Hey @timja, I will have a look at this today

Nancy-Chauhan · May 15, 2022, 11:59am

Hey @timja, I have made the changes and raised a PR in your repo. Wait for jenkins port to be available by Nancy-Chauhan · Pull Request #104 · timja/jenkins · GitHub

If it works for you, you can then raise it to Jenkins.

One thing I haven’t figured out is how to get the test URL when using a Jetbrains IDE.

You will need to run gp URL 8080 in the integrated terminal to get the URL. Click on the URL to open it in your browser.

If I open it in VS Code in the browser I get a notification prompting me to open the test instance.

I don’t seem to get the same notification in IntelliJ

IntelliJ gives this prompt only when we run the project using a run configuration.

After opening the project in IntelliJ, if you set up a maven target with the commands, IntelliJ will prompt you for port-forwarding.

timja · May 21, 2022, 6:40am

This is now working on the design library:

github.com

jenkinsci/design-library-plugin/blob/2d5791bed542a6ae217362c4074bef7c2f5e1648/.gitpod.yml

tasks:
  - init: mvn install -P quick-build
    command: |
      curl https://gist.githubusercontent.com/timja/fe73f0a0f98afe4d9356e7ce6752d95b/raw/a8d772267bed81fb0c11af2c69eaa71ebc7daec0/init.sh | bash
      # without host being `0.0.0.0` redirects will go to localhost ignoring the forwarded values for some reason
      mvn hpi:run -Dhost=0.0.0.0
    name: Run
  - command: gp await-port 63342 && gp await-port 8080 && gp url 8080 && gp preview $(gp url 8080)/jenkins/
    name: Preview

github:
  prebuilds:
    pullRequestsFromForks: true
    addBadge: true

jetbrains:
  intellij:
    plugins:
      - Stapler plugin for IntelliJ IDEA

Jenkins core PR opened:

github.com/jenkinsci/jenkins

Add gitpod integration

jenkinsci:master ← timja:gitpod

opened 06:50AM - 20 May 22 UTC

timja

+39 -1

Gitpod is a cloud development environment that you can use to quickly get up to speed on a project by just clicking 'Open in gitpod'. It can pre-build workspaces so you don't have to wait for it to get setup. You can see it in use on https://github.com/jenkinsci/design-library-plugin/pull/67 Supported IDEs are VS Code and Intelli J. What do you think? cc @Nancy-Chauhan (for the below button to appear automatically I would need to install the GitHub app on this repository which I can do after this is accepted) <a href="https://gitpod.io/#https://github.com/jenkinsci/jenkins/pull/6590"><img src="https://gitpod.io/button/open-in-gitpod.svg"/></a>  ### Proposed changelog entries * Entry 1: Issue, Human-readable Text * ...  ### Proposed upgrade guidelines N/A ### Submitter checklist - [ ] (If applicable) Jira issue is well described - [ ] Changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developer, depending on the change) and are in the imperative mood. [Examples](https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml) * Fill-in the `Proposed changelog entries` section only if there are breaking changes or other changes which may require extra steps from users during the upgrade - [ ] Appropriate autotests or explanation to why this change has no tests - [ ] New public classes, fields, and methods are annotated with `@Restricted` or have `@since TODO` Javadoc, as appropriate. - [ ] For dependency updates: links to external changelogs and, if possible, full diffs ### Desired reviewers @mention  ### Maintainer checklist Before the changes are marked as `ready-for-merge`: - [ ] There are at least 2 approvals for the pull request and no outstanding requests for change - [ ] Conversations in the pull request are over OR it is explicit that a reviewer does not block the change - [ ] Changelog entries in the PR title and/or `Proposed changelog entries` are accurate, human-readable, and in the imperative mood - [ ] Proper changelog labels are set so that the changelog can be generated automatically - [ ] If the change needs additional upgrade steps from users, `upgrade-guide-needed` label is set and there is a `Proposed upgrade guidelines` section in the PR title. ([example](https://github.com/jenkinsci/jenkins/pull/4387)) - [ ] If it would make sense to backport the change to LTS, a Jira issue must exist, be a _Bug_ or _Improvement_, and be labeled as `lts-candidate` to be considered (see [query](https://issues.jenkins.io/issues/?filter=12146)).

Nancy-Chauhan · May 25, 2022, 10:12am

Wow! Thank you, @timja, for raising PR “Add gitpod integration” in core Jenkins. This will be good