How to try out any JabRef pull request

Beta Testing
1

JabRef gets many contributions by external contributors in the form of pull requests. Want to try out the feature or fix?

You can do so in a few simple steps, and give early feedback!

Quick way

In case you have a GitHub account, GitHub CLI, git, any Java JDK, installed - and any checkout of JabRef, you can do following:

  1. Checkout PR: gh pr checkout 13182
  2. Run GUI: ./gradlew :jabgui:run

In case you don’t have these tools installed, here are some hints:

Windows

  1. According to Microsoft’s information, winget should be available on your Windows.
  2. Open administrative shell (cmd or Powershell)
  3. Install GitHub CLI: winget install --id=GitHub.cli -e
  4. Install git: winget install --id=Git.Git -e
  5. Install JDK: winget install --id=EclipseAdoptium.Temurin.21.JDK -e
  6. Close the shell
  7. Open a shell as user
  8. Login into GitHub: gh auth login
  9. Clone JabRef following the hints at our contribution guide.

Way without GitHub account

You can use our JBang-script to checkout:

  1. In the source directory of JabRef: jbang .jbang/CheckoutPR.java 13182
  2. Run GUI: ./gradlew :jabgui:run

JBang installation instractions can be found at Installation :: JBang.

If you don’t have a JabRef checkout, clone JabRef following the hints at our contribution guide.

Way without installing anything

If you don’t want to install anything, downloading a little helper script and executing some commands are enough. We posted a guide at How to try out any JabRef pull request | JabRef's Blog.