Skip to content

Commit 29fbfdb

Browse files
committed
Merge branch 'jdk25' into fix-jpackage-post-image
2 parents 4ee3c05 + 1f810ef commit 29fbfdb

File tree

1,553 files changed

+91104
-17207
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,553 files changed

+91104
-17207
lines changed

.devcontainer/devcontainer.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,10 @@
3131
// Install java.
3232
// See https://github.com/devcontainers/features/tree/main/src/java#options for details.
3333
"ghcr.io/devcontainers/features/java:1": {
34-
"version": "24.0.1-tem",
35-
"installGradle": false,
36-
"jdkDistro": "Temurin"
34+
"version": "latest",
35+
"installGradle": true,
36+
"gradleVersion": "latest",
37+
"jdkDistro": "Corretto"
3738
}
3839
}
3940
}

.dockerignore

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
1+
.git
12
.gitignore
23
.dockerignore
34

45
Dockerfile
56
Dockerfile.*
67
.github/
78

9+
.devcontainer/
10+
11+
*/bin
12+
*/build
13+
*/out
14+
15+
docs/
16+
17+
gg.cmd
18+
gradlew.bat
19+
820
# no generated files in version control
921
src/main/gen/
1022
src/main/generated/
1123
src-gen/
1224

13-
src/main/resources/csl-styles
14-
src/main/resources/csl-locales
15-
buildres/abbrv.jabref.org
16-
17-
jablib/src/main/resources/csl-styles
18-
jablib/src/main/resources/csl-locales
19-
2025
.lycheecache
2126

2227
.kotlin

.git-blame-ignore-revs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Automatic code reformatting
2+
f3cfa496e028dee1cafd0c47553f63cd1243bd8c
23
c5bcad738fe6e8dfcb62442a426c2778241515a1
4+
10189bf2c1a6bc506f03461390f3cc46e5cc0651
5+
16fd6194b9a0b8282259c00b6fb0d4aa494e4b04
36

47
# net.sf.jabref -> org.jabref
58
b2ad6eb279f5def38fa21be12cb5dd4545c1ba1a
@@ -23,6 +26,6 @@ bf81b595a77f0f7f254872be6f05a063c44528d8
2326

2427
# This commit should not exist
2528
185d7345946c29a2a4e2726c912be0c4db4810b9
26-
# Resulted in this problematic merge commits
29+
# ... and resulted in this problematic merge commits
2730
7e1645978b3028df5e65af19f0f819ddfd0f24aa
2831
a31f396765492ac12eaab228e33eb9d22487403b

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Closes _____
77

88
### Steps to test
99

10-
<!-- Describe how reviewers can test this fix/feature. Ideally, think of how you would guide a beginner user of Jabef to try out your change. -->
10+
<!-- Describe how reviewers can test this fix/feature. Ideally, think of how you would guide a beginner user of JabRef to try out your change. -->
1111
<!-- You can add screenshots or videos (using Loom - https://www.loom.com or by just adding .mp4 files). -->
1212
<!-- (REPLACE THIS PARAGRAPH) -->
1313

14-
<!-- YOU HAVE TO MODIFY THE ABOVE TEXT FIT YOUR PR. OTHERWISE, YOUR PR WILL BE CLOSED WITHOUT FURTHER COMMENT. -->
14+
<!-- YOU HAVE TO MODIFY THE ABOVE TEXT TO FIT YOUR PR. OTHERWISE, YOUR PR WILL BE CLOSED WITHOUT FURTHER COMMENT. -->
1515

1616
### Mandatory checks
1717

@@ -25,9 +25,8 @@ Keep ALL the items. Replace the dots inside [.] and mark them as follows:
2525
-->
2626

2727
- [x] I own the copyright of the code submitted and I license it under the [MIT license](https://github.com/JabRef/jabref/blob/main/LICENSE)
28-
- [.] Change in `CHANGELOG.md` described in a way that is understandable for the average user (if change is visible to the user)
29-
- [.] Tests created for changes (if applicable)
30-
- [.] Manually tested changed features in running JabRef (always required)
31-
- [.] Screenshots added in PR description (if change is visible to the user)
32-
- [.] [Checked developer's documentation](https://devdocs.jabref.org/): Is the information available and up to date? If not, I outlined it in this pull request.
33-
- [.] [Checked documentation](https://docs.jabref.org/): Is the information available and up to date? If not, I created an issue at <https://github.com/JabRef/user-documentation/issues> or, even better, I submitted a pull request to the documentation repository.
28+
- [.] I manually tested my changes in running JabRef (always required)
29+
- [.] I added JUnit tests for changes (if applicable)
30+
- [.] I added screenshots in the PR description (if change is visible to the user)
31+
- [.] I described the change in `CHANGELOG.md` in a way that is understandable for the average user (if change is visible to the user)
32+
- [.] I checked the [user documentation](https://docs.jabref.org/): Is the information available and up to date? If not, I created an issue at <https://github.com/JabRef/user-documentation/issues> or, even better, I submitted a pull request updating file(s) in <https://github.com/JabRef/user-documentation/tree/main/en>.

.github/dependabot.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@ updates:
33
- package-ecosystem: gradle
44
directories:
55
- "/build-logic" # versions of 3rd party gradle plugins
6+
- "jablib"
67
- "/versions" # versions of 3rd party dependencies of all JabRef modules
8+
- "/" # plugins
79
schedule:
810
interval: weekly
11+
day: sunday
912
labels:
1013
- "dependencies"
1114
ignore:
@@ -19,9 +22,11 @@ updates:
1922
directory: "/"
2023
schedule:
2124
interval: weekly
25+
day: sunday
2226
labels:
2327
- "dependencies"
2428
- package-ecosystem: "gitsubmodule"
2529
directory: "/"
2630
schedule:
2731
interval: weekly
32+
day: sunday

.github/ghprcomment.yml

Lines changed: 67 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Compilation, tests, and code style
22

33
- jobName: windows installer and portable version
4+
workflowName: 'Source Code Tests'
45
message: >
56
Your code does not compile.
67
Please ensure your changes compile successfully before pushing changes.
@@ -9,38 +10,52 @@
910
To verify compilation locally, run `./gradlew build` or try running JabRef.
1011
1112
- jobName: 'Unit tests – jablib'
13+
workflowName: 'Source Code Tests'
1214
message: >
1315
JUnit tests of `jablib` are failing.
1416
You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page.
15-
To see the test output, locate "Tests / Unit tests (pull_request)" and click on it.
17+
To see the test output, locate "Source Code Tests / Unit tests (pull_request)" and click on it.
1618
1719
1820
You can then run these tests in IntelliJ to reproduce the failing tests locally.
1921
We offer a quick test running howto in the section [Final build system checks](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.html#final-build-system-checks) in our setup guide.
2022
- jobName: 'Unit tests – jabkit'
23+
workflowName: 'Source Code Tests'
2124
message: >
2225
JUnit tests of `jabkit` are failing.
2326
You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page.
24-
To see the test output, locate "Tests / Unit tests (pull_request)" and click on it.
27+
To see the test output, locate "Source Code Tests / Unit tests (pull_request)" and click on it.
2528
2629
2730
You can then run these tests in IntelliJ to reproduce the failing tests locally.
2831
We offer a quick test running howto in the section [Final build system checks](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.html#final-build-system-checks) in our setup guide.
2932
- jobName: 'Unit tests – jabsrv'
33+
workflowName: 'Source Code Tests'
3034
message: >
3135
JUnit tests of `jabsrv` are failing.
3236
You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page.
33-
To see the test output, locate "Tests / Unit tests (pull_request)" and click on it.
37+
To see the test output, locate "Source Code Tests / Unit tests (pull_request)" and click on it.
3438
3539
3640
You can then run these tests in IntelliJ to reproduce the failing tests locally.
3741
We offer a quick test running howto in the section [Final build system checks](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.html#final-build-system-checks) in our setup guide.
42+
- jobName: format
43+
workflowName: 'Source Code Tests'
44+
message: >
45+
Your code currently does not meet JabRef's code guidelines.
46+
IntelliJ auto format covers some cases.
47+
There seem to be issues with your code style and autoformat configuration.
48+
Please reformat your code (<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>L</kbd>) and commit, then push.
49+
50+
51+
In special cases, consider using `// formatter:off` and `// formatter:on` annotations to allow deviation from the code style.
3852
- jobName: Checkstyle
53+
workflowName: 'Source Code Tests'
3954
message: >
4055
Your code currently does not meet [JabRef's code guidelines](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html).
4156
We use [Checkstyle](https://checkstyle.sourceforge.io/) to identify issues.
4257
You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page.
43-
To see the test output, locate "Tests / Checkstyle (pull_request)" and click on it.
58+
To see the test output, locate "Source Code Tests / Checkstyle (pull_request)" and click on it.
4459
4560
4661
In case of issues with the import order, double check that you [activated Auto Import](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html#enable-proper-import-cleanup).
@@ -50,77 +65,98 @@
5065
Please carefully follow [the setup guide for the codestyle](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html).
5166
Afterwards, please [run checkstyle locally](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html#run-checkstyle) and fix the issues, commit, and push.
5267
- jobName: OpenRewrite
68+
workflowName: 'Source Code Tests'
5369
message: >
5470
Your code currently does not meet JabRef's code guidelines.
5571
We use [OpenRewrite](https://docs.openrewrite.org/) to ensure "modern" Java coding practices.
5672
You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page.
57-
To see the test output, locate "Tests / OpenRewrite (pull_request)" and click on it.
73+
To see the test output, locate "Source Code Tests / OpenRewrite (pull_request)" and click on it.
5874
5975
6076
The issues found can be **automatically fixed**.
6177
Please execute the gradle task *`rewriteRun`* from the [`rewrite` group of the Gradle Tool window](https://devdocs.jabref.org/code-howtos/faq.html#failing-openrewrite-tests) in IntelliJ, then check the results, commit, and push.
6278
- jobName: Modernizer
79+
workflowName: 'Source Code Tests'
6380
message: >
6481
Your code currently does not meet JabRef's code guidelines.
6582
We use [Gradle Modernizer Plugin](https://github.com/andygoossens/gradle-modernizer-plugin#gradle-modernizer-plugin) to ensure "modern" Java coding practices.
6683
You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page.
67-
To see the test output, locate "Tests / Modernizer (pull_request)" and click on it.
84+
To see the test output, locate "Source Code Tests / Modernizer (pull_request)" and click on it.
6885
6986
7087
Please fix the detected errors, commit, and push.
7188
7289
# CHANGELOG.md and *.md
7390

74-
- jobName: 'CHANGELOG.md needs to be modified'
91+
- jobName: 'CHANGELOG.md needs to be modified if indicated'
92+
workflowName: 'Check PR CHANGELOG.md'
7593
message: >
7694
You ticked that you modified `CHANGELOG.md`, but no new entry was found there.
7795
7896
7997
If you made changes that are visible to the user, please add a brief description along with the issue number to the `CHANGELOG.md` file.
8098
If you did not, please replace the cross (`[x]`) by a slash (`[/]`) to indicate that no `CHANGELOG.md` entry is necessary.
8199
More details can be found in our [Developer Documentation about the changelog](https://devdocs.jabref.org/decisions/0007-human-readable-changelog.html).
82-
- jobName: CHANGELOG.md
100+
- jobName: 'CHANGELOG.md - only unreleased touched'
101+
workflowName: 'Source Code Tests'
83102
message: >
84103
While the PR was in progress, a new version of JabRef has been released.
85104
86105
87106
You have to merge `upstream/main` and move your entry in `CHANGELOG.md` up to the section `## [Unreleased]`.
107+
- jobName: CHANGELOG.md
108+
workflowName: 'Source Code Tests'
109+
message: >
110+
You modified `CHANGELOG.md` and did not meet JabRef's rules for consistently formatted Markdown files.
111+
To ensure consistent styling, we have [markdown-lint](https://github.com/DavidAnson/markdownlint) in place.
112+
[Markdown lint's rules](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#rules) help to keep our Markdown files consistent within this repository and consistent with the Markdown files outside here.
113+
114+
115+
You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Source Code Tests" (on the left), subsection "CHANGELOG.md".
88116
- jobName: Markdown
117+
workflowName: 'Source Code Tests'
89118
message: >
90119
You modified Markdown (`*.md`) files and did not meet JabRef's rules for consistently formatted Markdown files.
91120
To ensure consistent styling, we have [markdown-lint](https://github.com/DavidAnson/markdownlint) in place.
92121
[Markdown lint's rules](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#rules) help to keep our Markdown files consistent within this repository and consistent with the Markdown files outside here.
93122
94123
95-
You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "Markdown".
124+
You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Source Code Tests" (on the left), subsection "Markdown".
96125
97126
98127
# Submodules and branches
99128

100129
- jobName: 'Submodules not modified'
130+
workflowName: 'Check PR Modifications'
101131
message: >
102132
Your pull request modified git submodules.
103133
104134
105135
Please follow our [FAQ on submodules](https://devdocs.jabref.org/code-howtos/faq.html#submodules) to fix.
106136
- jobName: no-force-push
137+
workflowName: 'Check PR Modifications'
107138
always: true
108139
message: >
109140
Hey, we noticed that you **force-pushed** your changes.
110141
Force pushing is a bad practice when working together on a project (mainly because it is [not supported well by GitHub itself](https://github.com/orgs/community/discussions/3478)).
111142
Commits are lost and comments on commits lose their context, thus making it harder to review changes.
112-
At the end, all commits will be [squashed](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) anyway before being merged into the `main` branch.
143+
144+
145+
When the pull request is getting integrated into `main`, all commits will be [squashed](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) anyway.
146+
Thus, your individual commit history will not be visible in `main`.
113147
114148
115149
In future, **please avoid that**. For now, you can continue working.
116150
- jobName: 'Conflicts with target branch'
151+
workflowName: 'On PR opened/updated'
117152
message: >
118153
Your pull request conflicts with the target branch.
119154
120155
121156
Please [merge `upstream/main`](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork#syncing-a-fork-branch-from-the-command-line) with your code.
122157
For a step-by-step guide to resolve merge conflicts, see <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line>.
123158
- jobName: 'Source branch is other than "main"'
159+
workflowName: 'Check PR Modifications'
124160
message: >
125161
You committed your code on the `main` brach of your fork. This is a bad practice.
126162
The right way is to branch out from `main`, work on your patch/feature in that new branch, and then get that branch merged via the pull request (see [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow)).
@@ -131,26 +167,41 @@
131167
See [CONTRIBUTING.md](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md#pull-request-process) for more details.
132168
133169
134-
# PR text
170+
# PR hygiene
171+
172+
- jobName: 'Ensure that contributor is assigned (fails if not commented on issue)'
173+
workflowName: 'On PR opened/updated'
174+
message: >
175+
You did not assign yourself to the issue.
176+
Thus, it looks like you skipped reading our [CONTRIBUTING.md](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md), which explains exactly how to participate. No worries, it happens to the best of us.
177+
178+
179+
Give it a read, and you’ll discover the ancient wisdom of assigning issues to yourself. Trust me, it’s worth it. 🚀
135180
181+
- jobName: 'PR title must not contain "issue <number>"'
182+
workflowName: 'PR Format'
183+
always: true
184+
message: >
185+
The title of the pull request must not start with "Fix for issue xyz".
186+
Please use a concise one-line summary that explains what the fix or change actually does.
187+
Example of a good title: "Prevent crash when importing malformed BibTeX entries".
136188
- jobName: 'Mandatory Checks present'
189+
workflowName: 'PR Format'
137190
always: true
138191
message: >
139192
You have removed the "Mandatory Checks" section from your pull request description. Please adhere to our [pull request template](https://github.com/JabRef/jabref/blob/main/.github/PULL_REQUEST_TEMPLATE.md?plain=1#L10).
140193
- jobName: 'PR checklist OK'
194+
workflowName: 'PR Format'
141195
always: true
142196
message: >
143197
Note that your PR will not be reviewed/accepted until you have gone through the mandatory checks in the description and marked each of them them exactly in the format of `[x]` (done), `[ ]` (not done yet) or `[/]` (not applicable).
144198
- jobName: 'Determine issue number'
199+
workflowName: 'On PR opened/updated'
145200
always: true
146201
message: |
147202
Your pull request needs to link an issue correctly.
148203
149-
To ease organizational workflows, please link this pull-request to the issue with syntax as described in <https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue>:
150-
151-
> <h2 id="linking-a-pull-request-to-an-issue-using-a-keyword">Linking a pull request to an issue using a keyword</h2>
152-
> <p>You can link a pull request to an issue by using a supported keyword
153-
> in the pull request's description or in a commit message.
204+
To ease organizational workflows, please link this pull request to the issue by including a supported keyword in the pull request's description as per syntax described in [GitHub's documentation](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
154205
155206
### Examples
156207

0 commit comments

Comments
 (0)