xref: /Lucene/help/workflow.txt (revision 872349cef9071658ed7659b069c2fd8a4bc0d921)
1Typical workflow and tasks
2==========================
3
4This shows some typical workflow gradle commands.
5
6Ensure your changes are correctly formatted (run "gradlew :helpFormatting" for more):
7gradlew tidy
8
9Run tests on a module:
10gradlew -p lucene/core test
11
12Run test of a single-class (run "gradlew :helpTests" for more):
13gradlew -p lucene/core test --tests "*Demo*"
14
15Run all tests and validation checks on a module:
16gradlew -p lucene/core check
17
18Run all tests and validation checks on everything:
19gradlew check
20
21Run all validation checks but skip all tests:
22gradlew check -x test
23
24Assemble a single module's JAR (here for lucene-core):
25gradlew -p lucene/core assemble
26ls lucene/core/build/libs
27
28Assemble all Lucene artifacts (JARs, and so on):
29gradlew assemble
30
31Create all distributable packages, POMs, etc. and create a
32local maven repository for inspection:
33gradlew mavenLocal
34ls -R build/maven-local/
35
36Assemble Javdocs on a module:
37gradlew -p lucene/core javadoc
38ls lucene/core/build/docs
39
40Assemble entire documentation (including javadocs):
41gradlew documentation
42ls lucene/documentation/build/site
43
44
45Other validation and checks
46===========================
47
48Generate a report of dependencies with known OWASP vulnerabilities:
49gradlew :dependencyCheckAnalyze
50open ./build/reports/dependency-check-report.html
51