-
Notifications
You must be signed in to change notification settings - Fork 13
Add gg.cmd run-pr xyz #115
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.
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
Changes from 5 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
499fcdf
Create 2025-05-31-run-pr.md
koppor 39bebb2
Finish draft
koppor fae8366
Add link to user documentation
koppor ef52695
Finished
koppor a215a59
Apply suggestions from code review
koppor abbd220
Update 2025-05-31-run-pr.md
koppor 163f500
Change trouble shooting
koppor 9492ffe
Add explicit trust command
koppor 7521689
Add images
koppor 0fd68d2
Fix space
koppor a912f41
Switch to WDAGUtilityAccount - and make use of new just commands
koppor df70615
Final fixes
koppor 9b66822
Add link to Eclipse JGit
koppor ed29ef6
Change title
koppor a58e35e
Refine text
koppor 65712ce
Add "Using a Windows Sandbox"
koppor cb054df
Finish steps for sandbox
koppor 75643ac
Make step more exact
koppor 9eea76f
Apply suggestions from code review
koppor File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
title: Try out any JabRef pull request | ||
--- | ||
|
||
Thanks to the strong ecosystem of Java, one can easily try out (nearly) any JabRef pull request. | ||
For instance, to try out the "[initial implementation of walkthrough](https://github.com/JabRef/jabref/pull/13182)", one needs to execute following command: | ||
|
||
```cmd | ||
.\gg.cmd just run-pr 13182 | ||
``` | ||
|
||
As preparation, one needs to clone JabRef's source code and download [`gg.cmd`](https://github.com/eirikb/gg) and place it into the cloned source code directory. | ||
|
||
The preparation is also simplified by `gg.cmd`. | ||
|
||
1. [Download `gg.cmd`](https://github.com/eirikb/gg/releases/latest/download/gg.cmd) | ||
2. Execute `.\gg.cmd jbang https://github.com/JabRef/jabref/blob/main/.jbang/CloneJabRef.java`. This will clone JabRef into a temporary folder. | ||
|
||
1. Initialization\ | ||
 | ||
2. JBang will ask for trust - please trust the script with <kbd>2</kbd> and then <kbd>Enter</kbd>\ | ||
 | ||
3. Clone happens\ | ||
 | ||
|
||
3. After it finishes, it will output the directory: | ||
|
||
```text | ||
JabRef code available at: C:\Users\koppor\AppData\Local\Temp\jabref | ||
``` | ||
|
||
4. Go to the directory: `cd C:\Users\koppor\AppData\Local\Temp\jabref` (Note - replace "`koppor`" with your username). | ||
5. Move `gg.cmd` to here: `move C:\Users\koppor\Downloads\gg.cmd .`. (Note - replace "`koppor`" with your username. The path also needs to be changed if you have downloaded `gg.cmd` anywhere else). | ||
6. Now you can run a PR using `.\gg.cmd just run-pr 13182` (replace 13182 with the PR number of whichever PR you want to try out). Initially, this might take several minutes, as the build environment has to be initialized and JabRef is build completely from scratch. You will also need to tell JBang to trust JabRef's code. In later runs the run will be faster. | ||
|
||
## Troubleshooting | ||
|
||
For Linux and macOS, use `sh ./gg.cmd` instead of `.\gg.cmd`. | ||
|
||
You might get "error: No justfile found" | ||
|
||
```monospace | ||
just gui | ||
error: No justfile found | ||
error: Recipe `run-pr` failed on line 21 with exit code 1 | ||
Unable to execute | ||
``` | ||
|
||
Then, the pull request has not merged recent `main`. | ||
You need to "manually" start: | ||
subhramit marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```cmd | ||
.\gg.cmd gradle :jabgui:run | ||
``` | ||
|
||
## More Information | ||
|
||
More information is available in our [contributing guide](https://docs.jabref.org/contributing#i-would-like-to-try-out-a-feature-introduced-at-pull-request). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.