forked from JabRef/jabref
-
Notifications
You must be signed in to change notification settings - Fork 0
/
build.gradle
762 lines (655 loc) · 30.7 KB
/
build.gradle
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
import groovy.json.JsonSlurper
import org.gradle.internal.os.OperatingSystem
import org.jabref.build.JournalAbbreviationConverter
import org.jabref.build.antlr.JabRefAntlrPlugin
import org.jabref.build.localization.LocalizationPlugin
import org.jabref.build.xjc.XjcPlugin
import org.jabref.build.xjc.XjcTask
// to update the gradle wrapper, execute
// ./gradlew wrapper --gradle-version=6.0 --distribution-type=bin
plugins {
id 'application'
id "com.simonharrer.modernizer" version '1.8.0-1'
id 'me.champeau.gradle.jmh' version '0.5.0'
id 'com.github.ben-manes.versions' version '0.28.0'
id 'org.javamodularity.moduleplugin' version '1.5.0'
id 'org.openjfx.javafxplugin' version '0.0.8'
id 'org.beryx.jlink' version '2.19.0'
// nicer test outputs during running and completion
id 'com.adarshr.test-logger' version '2.0.0'
}
gradle.startParameter.showStacktrace = org.gradle.api.logging.configuration.ShowStacktrace.ALWAYS
apply plugin: 'java'
apply plugin: 'application'
apply plugin: 'project-report'
apply plugin: 'jacoco'
apply plugin: 'me.champeau.gradle.jmh'
apply plugin: 'checkstyle'
apply plugin: JabRefAntlrPlugin
apply plugin: XjcPlugin
apply plugin: LocalizationPlugin
apply from: 'eclipse.gradle'
group = "org.jabref"
version = project.findProperty('projVersion') ?: '100.0.0'
java {
sourceCompatibility = JavaVersion.VERSION_14
targetCompatibility = JavaVersion.VERSION_14
}
application {
mainClassName = "$moduleName/org.jabref.JabRefLauncher"
}
// TODO: Ugly workaround to temporarily ignore build errors to dependencies of latex2unicode
// These should be removed, as well as the files in the lib folder, as soon as they have valid module names
patchModules.config = [
"test=fastparse_2.12-1.0.0.jar",
"test2=fastparse-utils_2.12-1.0.0.jar",
"test3=sourcecode_2.12-0.1.4.jar"
]
// These are the Java version requirements we will check on each start of JabRef
ext.minRequiredJavaVersion = "1.8.0_171"
ext.allowJava9 = true
sourceSets {
main {
java {
srcDirs = ["src/main/java", "src/main/gen"]
}
resources {
srcDirs = ["src/main/java", "src/main/resources"]
}
}
test {
java {
srcDirs = ["src/test/java"]
}
resources {
srcDirs = ["src/test/resources"]
}
}
}
repositories {
mavenLocal()
jcenter()
maven { url 'https://oss.sonatype.org/content/groups/public' }
maven { url 'https://repository.apache.org/snapshots' }
}
configurations {
libreoffice
// TODO: Remove the following workaround for split error messages such as
// error: module java.xml.bind reads package javax.annotation from both jsr305 and java.annotation
compile {
exclude group: "javax.activation"
}
}
javafx {
version = "14"
modules = [ 'javafx.controls', 'javafx.fxml', 'javafx.web', 'javafx.swing' ]
}
dependencies {
// Include all jar-files in the 'lib' folder as dependencies
implementation fileTree(dir: 'lib', includes: ['*.jar'])
implementation 'org.apache.pdfbox:pdfbox:2.0.19'
implementation 'org.apache.pdfbox:fontbox:2.0.19'
implementation 'org.apache.pdfbox:xmpbox:2.0.19'
implementation group: 'org.apache.commons', name: 'commons-csv', version: '1.8'
implementation 'com.h2database:h2-mvstore:1.4.200'
implementation group: 'org.apache.tika', name: 'tika-core', version: '1.24.1'
// required for reading write-protected PDFs - see https://github.com/JabRef/jabref/pull/942#issuecomment-209252635
implementation 'org.bouncycastle:bcprov-jdk15on:1.65.01'
implementation 'commons-cli:commons-cli:1.4'
// For Java 9+ compatibility, we include a bundled version of the libreoffice libraries
// See https://bugs.documentfoundation.org/show_bug.cgi?id=117331#c8 for background information
// Use the task bundleLibreOffice to update the bundled jar
// DO NOT CHANGE THE libreoffice PREFIX
libreoffice 'org.libreoffice:juh:6.4.3'
libreoffice 'org.libreoffice:jurt:6.4.3'
libreoffice 'org.libreoffice:ridl:6.4.3'
libreoffice 'org.libreoffice:unoil:6.4.3'
implementation 'io.github.java-diff-utils:java-diff-utils:4.7'
implementation 'info.debatty:java-string-similarity:2.0.0'
antlr3 'org.antlr:antlr:3.5.2'
implementation 'org.antlr:antlr-runtime:3.5.2'
antlr4 'org.antlr:antlr4:4.8-1'
implementation 'org.antlr:antlr4-runtime:4.8-1'
implementation group: 'org.mariadb.jdbc', name: 'mariadb-java-client', version: '2.6.0'
implementation 'org.postgresql:postgresql:42.2.12'
implementation ('com.oracle.ojdbc:ojdbc10:19.3.0.0') {
// causing module issues
exclude module: 'oraclepki'
}
implementation ('com.google.guava:guava:29.0-jre') {
// TODO: Remove this as soon as https://github.com/google/guava/issues/2960 is fixed
exclude module: "jsr305"
}
implementation group: 'jakarta.annotation', name: 'jakarta.annotation-api', version: '1.3.5'
// JavaFX stuff
implementation 'de.jensd:fontawesomefx-commons:11.0'
implementation 'de.jensd:fontawesomefx-materialdesignfont:1.7.22-11'
implementation 'de.saxsys:mvvmfx-validation:1.9.0-SNAPSHOT'
implementation 'de.saxsys:mvvmfx:1.8.0'
implementation 'com.tobiasdiez:easybind:2.0.0-SNAPSHOT'
implementation 'org.fxmisc.flowless:flowless:0.6.1'
implementation 'org.fxmisc.richtext:richtextfx:0.10.5'
implementation group: 'org.glassfish.hk2.external', name: 'jakarta.inject', version: '2.6.1'
implementation 'com.jfoenix:jfoenix:9.0.9'
implementation 'org.controlsfx:controlsfx:11.0.1'
implementation 'org.jsoup:jsoup:1.13.1'
implementation 'com.konghq:unirest-java:3.7.02'
implementation 'org.slf4j:slf4j-api:2.0.0-alpha1'
implementation group: 'org.apache.logging.log4j', name: 'log4j-jcl', version: '3.0.0-SNAPSHOT'
implementation group: 'org.apache.logging.log4j', name: 'log4j-slf4j18-impl', version: '3.0.0-SNAPSHOT'
implementation group: 'org.apache.logging.log4j', name: 'log4j-plugins', version: '3.0.0-SNAPSHOT'
implementation group: 'org.apache.logging.log4j', name: 'log4j-api', version: '3.0.0-SNAPSHOT'
implementation group: 'org.apache.logging.log4j', name: 'log4j-core', version: '3.0.0-SNAPSHOT'
annotationProcessor group: 'org.apache.logging.log4j', name: 'log4j-core', version: '3.0.0-SNAPSHOT'
implementation 'de.undercouch:citeproc-java:2.1.0-SNAPSHOT'
implementation group: 'jakarta.activation', name: 'jakarta.activation-api', version: '1.2.1'
implementation group: 'jakarta.xml.bind', name: 'jakarta.xml.bind-api', version: '2.3.2'
implementation group: 'org.glassfish.jaxb', name: 'jaxb-runtime', version: '2.3.2'
implementation ('com.github.tomtung:latex2unicode_2.12:0.2.6') {
exclude module: 'fastparse_2.12'
}
implementation group: 'com.microsoft.azure', name: 'applicationinsights-core', version: '2.4.1'
implementation (group: 'com.microsoft.azure', name: 'applicationinsights-logging-log4j2', version: '2.4.1') {
exclude module: "log4j-core"
}
implementation 'com.vladsch.flexmark:flexmark:0.62.0'
implementation 'com.vladsch.flexmark:flexmark-ext-gfm-strikethrough:0.62.0'
implementation 'com.vladsch.flexmark:flexmark-ext-gfm-tasklist:0.62.0'
testImplementation 'io.github.classgraph:classgraph:4.8.78'
testImplementation 'org.junit.jupiter:junit-jupiter:5.6.2'
testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.6.2'
testImplementation 'org.junit.platform:junit-platform-launcher:1.6.2'
testImplementation 'net.bytebuddy:byte-buddy-parent:1.10.10'
testRuntime group: 'org.apache.logging.log4j', name: 'log4j-core', version: '3.0.0-SNAPSHOT'
testRuntime group: 'org.apache.logging.log4j', name: 'log4j-jul', version: '3.0.0-SNAPSHOT'
testImplementation 'org.mockito:mockito-core:3.3.3'
testImplementation 'org.xmlunit:xmlunit-core:2.7.0'
testImplementation 'org.xmlunit:xmlunit-matchers:2.7.0'
testImplementation 'com.tngtech.archunit:archunit-junit5-api:0.14.1'
testImplementation "org.testfx:testfx-core:4.0.17-alpha-SNAPSHOT"
testImplementation "org.testfx:testfx-junit5:4.0.17-alpha-SNAPSHOT"
testImplementation "org.hamcrest:hamcrest-library:2.2"
checkstyle 'com.puppycrawl.tools:checkstyle:8.32'
xjc group: 'org.glassfish.jaxb', name: 'jaxb-xjc', version: '2.3.3'
jython 'org.python:jython-standalone:2.7.2'
}
dependencyUpdates {
outputFormatter = "json"
}
// We have some dependencies which cannot be updated due to various reasons.
dependencyUpdates.resolutionStrategy = {
componentSelection { rules ->
rules.all { ComponentSelection selection ->
boolean rejected = ['alpha', 'snapshot', 'beta', 'rc', 'cr', 'm', 'preview', 'b', 'ea'].any { qualifier ->
selection.candidate.version ==~ /(?i).*[.-]$qualifier[.\d-+]*/
}
if (rejected) {
selection.reject('Release candidate')
}
}
rules.withModule("de.jensd:fontawesomefx-materialdesignfont") { ComponentSelection selection ->
if (selection.candidate.version ==~ /2.0.26.*/) {
selection.reject('1.7.22-11 is actually newer (strange version system)')
}
}
rules.withModule("org.javamodularity.moduleplugin:org.javamodularity.moduleplugin.gradle.plugin") { ComponentSelection selection ->
if (selection.candidate.version ==~ /1.6.0/) {
selection.reject("Does not work due to bug, see https://github.com/JabRef/jabref/pull/5270")
}
}
rules.withModule("com.microsoft.azure:applicationinsights-core") { ComponentSelection selection ->
if (selection.candidate.version ==~ /2.5.0/ || selection.candidate.version ==~ /2.5.1/) {
selection.reject("Does not work due to bug, see https://github.com/JabRef/jabref/pull/5596")
}
}
rules.withModule("com.microsoft.azure:applicationinsights-logging-log4j2") { ComponentSelection selection ->
if (selection.candidate.version ==~ /2.5.0/ || selection.candidate.version ==~ /2.5.1/) {
selection.reject("Does not work due to bug, see https://github.com/JabRef/jabref/pull/5596")
}
}
}
}
task checkOutdatedDependencies(dependsOn: dependencyUpdates) {
doLast {
def dependencyReport = new JsonSlurper().parseText(new File("build/dependencyUpdates/report.json").text)
assert dependencyReport.outdated.count == 0: "There are outdated dependencies in build.gradle!\n Run ./gradlew dependencyUpdates to see which"
}
}
clean {
delete "src/main/gen"
}
processResources {
filteringCharset = 'UTF-8'
filesMatching("build.properties") {
expand(version: project.findProperty('projVersionInfo') ?: '100.0.0',
"year": String.valueOf(Calendar.getInstance().get(Calendar.YEAR)),
"authors": new File('AUTHORS').readLines().findAll { !it.startsWith("#") }.join(", "),
"developers": new File('DEVELOPERS').readLines().findAll { !it.startsWith("#") }.join(", "),
"azureInstrumentationKey": System.getenv('AzureInstrumentationKey'),
"springerNatureAPIKey": System.getenv('SpringerNatureAPIKey'),
"minRequiredJavaVersion": minRequiredJavaVersion,
"allowJava9": allowJava9
)
filteringCharset = 'UTF-8'
}
filesMatching("resource/**/meta.xml") {
expand version: project.version
}
}
task generateSource(dependsOn: ["generateBstGrammarSource",
"generateSearchGrammarSource",
"generateMedlineSource",
"generateBibtexmlSource",
"generateEndnoteSource",
"generateModsSource",
"generateJournalAbbreviationList"]) {
group = 'JabRef'
description 'Generates all necessary (Java) source files.'
}
task generateBstGrammarSource(type: org.jabref.build.antlr.AntlrTask) {
group = "JabRef"
description = 'Generates BstLexer.java and BstParser.java from the Bst.g grammar file using antlr3.'
antlr = ANTLR3
inputFile = 'src/main/antlr3/org/jabref/bst/Bst.g'
outputDir = 'src/main/gen/org/jabref/logic/bst/'
}
task generateSearchGrammarSource(type: org.jabref.build.antlr.AntlrTask) {
group = 'JabRef'
description = "Generates java files for Search.g antlr4."
antlr = ANTLR4
inputFile = "src/main/antlr4/org/jabref/search/Search.g4"
outputDir = "src/main/gen/org/jabref/search"
javaPackage = "org.jabref.search"
}
task generateMedlineSource(type: XjcTask) {
group = 'JabRef'
description = "Generates java files for the medline importer."
schemaFile = "src/main/resources/xjc/medline/medline.xsd"
outputDirectory = "src/main/gen/"
javaPackage = "org.jabref.logic.importer.fileformat.medline"
}
task generateBibtexmlSource(type: XjcTask) {
group = 'JabRef'
description = "Generates java files for the bibtexml importer."
schemaFile = "src/main/resources/xjc/bibtexml/bibtexml.xsd"
outputDirectory = "src/main/gen"
javaPackage = "org.jabref.logic.importer.fileformat.bibtexml"
}
task generateEndnoteSource(type: XjcTask) {
group = 'JabRef'
description = "Generates java files for the endnote importer."
schemaFile = "src/main/resources/xjc/endnote/endnote.xsd"
outputDirectory = "src/main/gen/"
javaPackage = "org.jabref.logic.importer.fileformat.endnote"
}
task generateModsSource(type: XjcTask) {
group = 'JabRef'
description = "Generates java files for the mods importer."
schemaFile = "src/main/resources/xjc/mods/mods-3-7.xsd"
bindingFile = "src/main/resources/xjc/mods/mods-binding.xjb"
outputDirectory = "src/main/gen/"
javaPackage = "org.jabref.logic.importer.fileformat.mods"
arguments = '-npa'
}
task generateJournalAbbreviationList(type: JournalAbbreviationConverter) {
group = 'JabRef'
description = "Converts the comma-separated journal abbreviation file to a H2 MVStore."
inputDir = file("src/main/resources/journals")
outputDir = file("src/main/resources/journals")
}
tasks.withType(JavaCompile) {
options.encoding = 'UTF-8'
}
compileJava {
options.compilerArgs << "-Xlint:none"
dependsOn "generateSource"
moduleOptions {
// TODO: Remove access to internal api
addExports = [
'javafx.controls/com.sun.javafx.scene.control' : 'org.jabref',
'org.controlsfx.controls/impl.org.controlsfx.skin' : 'org.jabref'
]
}
}
run {
// TODO: Remove access to internal api
jvmArgs '--add-exports', 'javafx.controls/com.sun.javafx.scene.control=org.jabref',
'--add-exports', 'org.controlsfx.controls/impl.org.controlsfx.skin=org.jabref',
'--add-opens', 'javafx.controls/javafx.scene.control=org.jabref',
'--add-opens', 'org.controlsfx.controls/org.controlsfx.control.textfield=org.jabref',
'--add-opens', 'javafx.controls/com.sun.javafx.scene.control=org.jabref',
// Not sure why we need to restate the controlfx exports
// Taken from here: https://github.com/controlsfx/controlsfx/blob/9.0.0/build.gradle#L1
"--add-exports", "javafx.graphics/com.sun.javafx.scene=org.controlsfx.controls",
"--add-exports", "javafx.graphics/com.sun.javafx.scene.traversal=org.controlsfx.controls",
"--add-exports", "javafx.graphics/com.sun.javafx.css=org.controlsfx.controls",
"--add-exports", "javafx.controls/com.sun.javafx.scene.control.behavior=org.controlsfx.controls",
"--add-exports", "javafx.controls/com.sun.javafx.scene.control=org.controlsfx.controls",
"--add-exports", "javafx.controls/com.sun.javafx.scene.control.inputmap=org.controlsfx.controls",
"--add-exports", "javafx.base/com.sun.javafx.event=org.controlsfx.controls",
"--add-exports", "javafx.base/com.sun.javafx.collections=org.controlsfx.controls",
"--add-exports", "javafx.base/com.sun.javafx.runtime=org.controlsfx.controls",
"--add-exports", "javafx.web/com.sun.webkit=org.controlsfx.controls",
"--add-exports", "javafx.graphics/com.sun.javafx.css=org.controlsfx.controls",
"--add-opens", "javafx.controls/javafx.scene.control.skin=org.controlsfx.controls",
"--add-opens", "javafx.graphics/javafx.scene=org.controlsfx.controls",
"--add-exports", "javafx.controls/com.sun.javafx.scene.control.behavior=com.jfoenix",
"--add-opens", "javafx.controls/com.sun.javafx.scene.control.behavior=com.jfoenix",
"--add-opens", "javafx.base/com.sun.javafx.binding=com.jfoenix",
"--add-opens", "javafx.graphics/com.sun.javafx.stage=com.jfoenix",
"--add-opens", "javafx.base/com.sun.javafx.event=com.jfoenix",
'--add-exports', 'com.oracle.truffle.regex/com.oracle.truffle.regex=org.graalvm.truffle'
// TODO: The following code should have the same affect as the above one, but doesn't work for some reason
// https://github.com/java9-modularity/gradle-modules-plugin/issues/89
moduleOptions {
addExports = [
'javafx.controls/com.sun.javafx.scene.control' : 'org.jabref',
'org.controlsfx.controls/impl.org.controlsfx.skin' : 'org.jabref',
'com.oracle.truffle.regex/com.oracle.truffle.regex' : 'org.graalvm.truffle'
]
addOpens = [
'javafx.controls/javafx.scene.control' : 'org.jabref',
'org.controlsfx.controls/org.controlsfx.control.textfield' : 'org.jabref'
]
}
}
javadoc {
options {
encoding = 'UTF-8'
version = true
author = true
}
}
localization.script = 'scripts/syncLang.py'
test {
useJUnitPlatform {
excludeTags 'DatabaseTest', 'FetcherTest', 'GUITest'
}
testLogging {
// set options for log level LIFECYCLE
// for debugging tests: add "STANDARD_OUT", "STANDARD_ERROR"
events = ["FAILED"]
exceptionFormat "full"
}
}
testlogger {
showPassed false
}
task databaseTest(type: Test) {
useJUnitPlatform {
includeTags 'DatabaseTest'
}
testLogging {
// set options for log level LIFECYCLE
events = ["FAILED"]
exceptionFormat "full"
}
}
task fetcherTest(type: Test) {
useJUnitPlatform {
includeTags 'FetcherTest'
}
testLogging {
// set options for log level LIFECYCLE
events = ["FAILED"]
exceptionFormat "full"
}
}
task guiTest(type: Test) {
useJUnitPlatform {
includeTags 'GUITest'
}
testLogging {
// set options for log level LIFECYCLE
events = ["FAILED"]
exceptionFormat "full"
}
}
// Test result tasks
task copyTestResources(type: Copy) {
from "${projectDir}/src/test/resources"
into "${buildDir}/classes/test"
}
processTestResources.dependsOn copyTestResources
tasks.withType(Test) {
reports.html.destination = file("${reporting.baseDir}/${name}")
}
task jacocoMergePrep() {
doFirst {
// Ignore failures of tests
tasks.withType(Test) {
ignoreFailures = true
}
}
}
test.mustRunAfter jacocoMergePrep
databaseTest.mustRunAfter jacocoMergePrep
fetcherTest.mustRunAfter jacocoMergePrep
task jacocoMerge(type: JacocoMerge) {
executionData files(
"$buildDir/jacoco/test.exec",
"$buildDir/jacoco/databaseTest.exec",
"$buildDir/jacoco/fetcherTest.exec").filter { it.exists() }
dependsOn jacocoMergePrep, test, databaseTest, fetcherTest
}
jacocoTestReport {
executionData jacocoMerge.destinationFile
dependsOn jacocoMerge
reports {
csv.enabled = true
html.enabled = true
xml.enabled = true // coveralls plugin depends on xml format report
}
}
// Code quality tasks
checkstyle {
// will only run when called explicitly from the command line
sourceSets = []
}
// Release tasks
task deleteInstallerTemp(type: Delete) {
delete "$buildDir/installer"
}
jpackage.dependsOn deleteInstallerTemp
jlink {
options = ['--strip-debug', '--compress', '2', '--no-header-files', '--no-man-pages']
launcher {
name = 'JabRef'
}
addOptions("--bind-services")
// TODO: Remove the following as soon as the dependencies are fixed (upstream)
// forceMerge is usually needed when some non-modular artifacts in the dependency graph use code that was previously part of the JDK
// but it was removed in the newer releases.
// The pom.xml associated with such a non-modular artifact does not mention that the artifact depends on the removed code
// (because the artifact was published when this code was still available in the JDK).
forceMerge "javafx"
forceMerge "controlsfx", "bcprov", "jaxb", "istack", "stax", "log4j"
// TODO: Remove the following correction to the merged module
// The module descriptor automatically generated by the plugin for the merged module contained some invalid entries.
// Execute ./gradlew suggestMergedModuleInfo and include the suggested directives here.
mergedModule {
requires 'java.xml'
requires 'com.sun.xml.txw2'
requires 'java.desktop'
requires 'org.objectweb.asm'
requires 'jdk.jfr'
requires 'jdk.unsupported'
requires 'com.google.gson'
requires 'java.management'
requires 'java.naming'
requires 'java.security.sasl'
requires 'com.sun.xml.fastinfoset'
requires 'jdk.security.jgss'
requires 'java.logging'
requires 'jdk.xml.dom'
requires 'java.sql'
requires 'java.rmi'
requires 'java.security.jgss'
requires 'com.oracle.truffle.regex'
requires 'jdk.jsobject'
requires 'jdk.management'
requires 'jdk.unsupported.desktop'
requires 'org.objectweb.asm.util'
requires 'java.scripting'
requires 'org.objectweb.asm.commons'
requires 'org.graalvm.truffle'
requires 'java.datatransfer'
requires 'java.compiler'
requires 'java.sql.rowset'
requires 'java.transaction.xa'
requires 'org.graalvm.sdk'
requires 'org.slf4j'
uses 'org.apache.logging.log4j.util.PropertySource'
uses 'org.apache.logging.log4j.core.util.WatchEventService'
uses 'org.apache.logging.log4j.plugins.processor.PluginService'
uses 'org.controlsfx.glyphfont.GlyphFont'
uses 'com.airhacks.afterburner.views.ResourceLocator'
uses 'com.oracle.truffle.js.runtime.Evaluator'
uses 'org.apache.logging.log4j.message.ThreadDumpMessage.ThreadInfoFactory'
uses 'com.airhacks.afterburner.injection.PresenterFactory'
uses 'com.oracle.truffle.js.runtime.builtins.JSFunctionLookup'
uses 'org.apache.logging.log4j.spi.Provider'
uses 'org.mariadb.jdbc.credential.CredentialPlugin'
uses 'org.mariadb.jdbc.tls.TlsSocketPlugin'
uses 'org.mariadb.jdbc.LocalInfileInterceptor'
uses 'javax.xml.bind.JAXBContextFactory'
provides 'javax.annotation.processing.Processor' with 'org.apache.logging.log4j.plugins.processor.PluginProcessor'
provides 'org.controlsfx.glyphfont.GlyphFont' with 'org.controlsfx.glyphfont.FontAwesome'
provides 'org.apache.logging.log4j.message.ThreadDumpMessage.ThreadInfoFactory' with 'org.apache.logging.log4j.core.message.ExtendedThreadInfoFactory'
provides 'org.mariadb.jdbc.tls.TlsSocketPlugin' with 'org.mariadb.jdbc.internal.protocol.tls.DefaultTlsSocketPlugin'
provides 'com.microsoft.applicationinsights.core.dependencies.io.grpc.ServerProvider' with 'com.microsoft.applicationinsights.core.dependencies.io.grpc.netty.shaded.io.grpc.netty.NettyServerProvider'
provides 'com.oracle.truffle.js.runtime.Evaluator' with 'com.oracle.truffle.js.parser.GraalJSEvaluator'
provides 'com.microsoft.applicationinsights.core.dependencies.io.grpc.NameResolverProvider' with 'com.microsoft.applicationinsights.core.dependencies.io.grpc.internal.DnsNameResolverProvider'
provides 'org.apache.logging.log4j.util.PropertySource' with 'org.apache.logging.log4j.util.EnvironmentPropertySource',
'org.apache.logging.log4j.util.SystemPropertiesPropertySource'
provides 'java.sql.Driver' with 'org.postgresql.Driver'
provides 'org.apache.logging.log4j.plugins.processor.PluginService' with 'org.apache.logging.log4j.plugins.convert.plugins.Log4jPlugins'
provides 'org.mariadb.jdbc.authentication.AuthenticationPlugin' with 'org.mariadb.jdbc.internal.com.send.authentication.CachingSha2PasswordPlugin',
'org.mariadb.jdbc.internal.com.send.authentication.ClearPasswordPlugin',
'org.mariadb.jdbc.internal.com.send.authentication.Ed25519PasswordPlugin',
'org.mariadb.jdbc.internal.com.send.authentication.NativePasswordPlugin',
'org.mariadb.jdbc.internal.com.send.authentication.OldPasswordPlugin',
'org.mariadb.jdbc.internal.com.send.authentication.SendGssApiAuthPacket',
'org.mariadb.jdbc.internal.com.send.authentication.SendPamAuthPacket',
'org.mariadb.jdbc.internal.com.send.authentication.Sha256PasswordPlugin'
provides 'org.mariadb.jdbc.credential.CredentialPlugin' with 'org.mariadb.jdbc.credential.aws.AwsIamCredentialPlugin',
'org.mariadb.jdbc.credential.env.EnvCredentialPlugin',
'org.mariadb.jdbc.credential.system.PropertiesCredentialPlugin'
provides 'org.apache.commons.logging.LogFactory' with 'org.apache.logging.log4j.jcl.LogFactoryImpl'
provides 'org.slf4j.spi.SLF4JServiceProvider' with 'org.apache.logging.slf4j.SLF4JServiceProvider'
provides 'org.apache.logging.log4j.spi.Provider' with 'org.apache.logging.log4j.core.impl.Log4jProvider'
provides 'java.security.Provider' with 'org.bouncycastle.jce.provider.BouncyCastleProvider',
'org.bouncycastle.pqc.jcajce.provider.BouncyCastlePQCProvider'
provides 'com.microsoft.applicationinsights.core.dependencies.io.grpc.ManagedChannelProvider' with 'com.microsoft.applicationinsights.core.dependencies.io.grpc.netty.shaded.io.grpc.netty.NettyChannelProvider'
provides 'com.oracle.truffle.js.runtime.builtins.JSFunctionLookup' with 'com.oracle.truffle.js.builtins.JSDefaultBuiltinLookup'
}
jpackage {
// In order for this to work, you need to dowload jpackage from https://jdk.java.net/jpackage/
// and put the path to the jdk-14 folder in the environment variable BADASS_JLINK_JPACKAGE_HOME
outputDir = "distribution"
if (OperatingSystem.current().isWindows()) {
// This requires WiX to be installed: https://github.com/wixtoolset/wix3/releases
installerType = "msi"
imageOptions = [
'--icon', "${projectDir}/src/main/resources/icons/jabref.ico",
]
installerOptions = [
'--vendor', 'JabRef',
'--app-version', "${project.version}",
'--verbose',
'--win-upgrade-uuid', 'd636b4ee-6f10-451e-bf57-c89656780e36',
'--win-dir-chooser',
'--win-shortcut',
'--win-menu',
'--temp', "$buildDir/installer",
'--resource-dir', "${projectDir}/buildres/windows",
'--file-associations', "${projectDir}/buildres/windows/bibtexAssociations.properties"
]
}
if (OperatingSystem.current().isLinux()) {
imageOptions = [
'--icon', "${projectDir}/src/main/resources/icons/JabRef-icon-64.png",
]
installerOptions = [
'--verbose',
'--vendor', 'JabRef',
'--app-version', "${project.version}",
// '--temp', "$buildDir/installer",
'--resource-dir', "${projectDir}/buildres/linux",
'--linux-menu-group', 'Office;',
'--linux-rpm-license-type', 'MIT',
// '--license-file', "${projectDir}/LICENSE.md",
'--description', 'JabRef is an open source bibliography reference manager. The native file format used by JabRef is BibTeX, the standard LaTeX bibliography format.',
'--linux-shortcut',
'--file-associations', "${projectDir}/buildres/linux/bibtexAssociations.properties"
]
}
if (OperatingSystem.current().isMacOsX()) {
imageOptions = [
'--icon', "${projectDir}/src/main/resources/icons/jabref.icns",
'--resource-dir', "${projectDir}/buildres/mac"
]
installerOptions = [
'--verbose',
'--vendor', 'JabRef',
'--app-version', "${project.version}",
'--file-associations', "${projectDir}/buildres/mac/bibtexAssociations.properties",
'--resource-dir', "${projectDir}/buildres/mac"
]
}
}
}
if (OperatingSystem.current().isWindows()) {
tasks.jpackageImage.doLast {
copy {
from("${projectDir}/buildres/windows") {
include "jabref.json", "jabref-chrome.json", "JabRefHost.bat", "JabRefHost.ps1"
}
into "$buildDir/distribution/JabRef"
}
}
}
if (OperatingSystem.current().isLinux()) {
tasks.jpackageImage.doLast {
copy {
from("${projectDir}/buildres/linux") {
include "native-messaging-host/**", "jabrefHost.py"
}
into "$buildDir/distribution/JabRef/lib"
}
}
}
// Delete unnecessary folder in application image
// TODO: Remove this workaround as soon as https://github.com/beryx/badass-jlink-plugin/issues/51 is fixed
task deleteModsFolder(type: Delete) {
delete "$buildDir/distribution/JabRef/app/mods"
}
deleteModsFolder.shouldRunAfter jpackageImage
jmh {
warmupIterations = 5
iterations = 10
fork = 2
}
// Source: https://stackoverflow.com/a/44168582/873282
task downloadDependencies {
description "Pre-downloads *most* dependencies"
doLast {
configurations.getAsMap().each { name, config ->
println "Retrieving dependencies for $name"
try {
config.files
} catch (e) {
// some cannot be resolved, just log them
project.logger.info e.message
}
}
}
}
task bundleLibreOffice(type: Jar) {
from configurations.libreoffice.collect { zipTree it }
manifest {
attributes 'Automatic-Module-Name': 'org.jabref.thirdparty.libreoffice'
}
destinationDir = file('lib')
archiveName = 'libreoffice.jar'
}