Skip to content

More easy run #571

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
merged 7 commits into from
May 31, 2025
Merged

More easy run #571

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6cd7a71
More easy run
koppor May 30, 2025
ff6dec0
Try to have image on next line
koppor May 30, 2025
558875c
Use "just" instead of "gh/casey/just"
koppor May 30, 2025
fd0e936
Update en/contributing/README.md
koppor May 30, 2025
98e2f71
Refine README.md
koppor May 31, 2025
03d1584
Merge branch 'main' into koppor-patch-2
koppor May 31, 2025
e757bb6
Apply suggestions from code review
koppor May 31, 2025
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
31 changes: 23 additions & 8 deletions en/contributing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ In the following, we try to give a minimal set of installation instructions to b
- `cd c:\git-repositories`
- Get `gg.cmd`
- `wget ggcmd.io -OutFile gg.cmd`
- Have JBang trust JabRef's source
- `.\gg.cmd jbang trust add https://github.com/JabRef/jabref/`
- Clone JabRef
- `.\gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CloneJabRef.java jabref`
- When JBang asks you for trust, you can choose "Trust once" by pressing <kbd>1</kbd> and then <kbd>Enter</kbd>
- NOTE: You can also use the native git client: `git clone --recurse-submodules https://github.com/JabRef/jabref.git` to achieve the same result.
- Make `gg.cmd` available in `jabref` source directory
- `cd jabref`
- `move ..\gg.cmd .`
Expand All @@ -39,33 +41,46 @@ In the following, we try to give a minimal set of installation instructions to b
- Get `gg.cmd` (using either `wget` or `curl`)
- `wget ggcmd.io/gg.cmd`
- Alternative: `curl -L ggcmd.io > gg.cmd`
- Have JBang trust JabRef's source
- `sh ./gg.cmd jbang trust add https://github.com/JabRef/jabref/`
- Clone JabRef
- `sh ./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CloneJabRef.java jabref`
- NOTE: You can also use the native git client: `git clone --recurse-submodules https://github.com/JabRef/jabref.git jabref` for achieving the same result.
- NOTE: You can also use the native git client: `git clone --recurse-submodules https://github.com/JabRef/jabref.git` to achieve the same result.
- Make `gg.cmd` available in `jabref` source directory
- `cd jabref`
- `mv ../gg.cmd .`

Now you are all set: You have a directory `jabref` containing the recent updates and also `gg.cmd` which you will need later for executing a JabRef build.

Note: If you don't want to store JabRef's source code permanently, you can follow the steps at [our blog post on gg.cmd usage](https://blog.jabref.org/2025/05/31/run-pr/). There, JabRef's source is checked out in a temporary directory.

### Try a branch

1. `cd` into the `jabref` source directory: `cd c:\git-repositories\jabref`
2. Checkout out the pull request: `sh ./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CheckoutPR.java 13182` - where `13182` is the PR number, in this case [pr#13182](https://github.com/JabRef/jabref/pull/13182).
2. Checkout the PR and run JabRef: `sh ./gg.cmd just run-pr <pr-number>` - replace `<pr-number>` with the PR number or the unique branch identifier by GitHub

- Instead of the number, you can also copy and paste the branch identifier output by GitHub: `sh ./gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CheckoutPR.java Yubo-Cao:walkthrough`.
- Example: `13182` for [pr#13182](https://github.com/JabRef/jabref/pull/13182).
- Example: `Yubo-Cao:walkthrough` for the branch identifier output by GitHub\
![pr-13182](../.gitbook/assets/pr-13182.png)

3. Compile and run JabRef: `sh ./gg.cmd gradle run :jabgui:run`. This will also download the necessary JDK and a gradle distribution. On the first run, please give the system enough time to accommodate and wait until the JabRef window launches. Depending on your hardware, this may take a few minutes.
This will download the necessary JDK and a gradle distribution.
On the first run, please give the system enough time to accommodate and wait until the JabRef window launches.
Depending on your hardware, this may take a few minutes.

On Windows, instead of `sh ./gg.cmd` use `.\gg.cmd`:

On Windows, instead of `sh ./gg.cmd` use `.\gg.cmd`.
.\gg.cmd just run-pr <pr-number>

#### Alternatives

1. In case you don't want to use `gg.cmd`: You can install [JBang](https://www.jbang.dev/) for yourself and execute the commands directly.
1. In case you don't want to use `gg.cmd`: You can install [JBang](https://www.jbang.dev/) for yourself and execute the commands directly. These are

- `jbang https://github.com/JabRef/jabref/blob/main/.jbang/CheckoutPR.java <pr-number>`
- `./gradlew :jabgui:run`

2. In case you don't want to use `JBang`:

- You have the project clone ready and have some Java JDK available: In the `JabRef` directory, execute `./gradlew run`.
- You have the project clone ready and have some [Java JDK](https://adoptium.net/de/temurin/releases/?os=any&arch=any&version=21) available: In the `jabref` directory, execute `./gradlew run`.
- Install `gh` (the [GitHub CLI](https://cli.github.com/), a command-line client for GitHub) by using the installer linked on their [homepage](https://cli.github.com/) or the commands given at the [installation hints](https://github.com/cli/cli#installation).

3. In case you don't want to use `gh`: You can use the "usual" `git clone ...`, `git remote add ...`, `git fetch ...`, and `git checkout ...` commands to checkout a pull request from a fork.
Expand Down