lucene/help/workflow.txt

51 lines
1.3 KiB
Plaintext

Typical workflow and tasks
==========================
This shows some typical workflow gradle commands.
Ensure your changes are correctly formatted (run "gradlew :helpFormatting" for more):
gradlew tidy
Run tests on a module:
gradlew -p lucene/core test
Run test of a single-class (run "gradlew :helpTests" for more):
gradlew -p lucene/core test --tests "*Demo*"
Run all tests and validation checks on a module:
gradlew -p lucene/core check
Run all tests and validation checks on everything:
gradlew check
Run all validation checks but skip all tests:
gradlew check -x test
Assemble a single module's JAR (here for lucene-core):
gradlew -p lucene/core assemble
ls lucene/core/build/libs
Assemble all Lucene artifacts (JARs, and so on):
gradlew assemble
Create all distributable packages, POMs, etc. and create a
local maven repository for inspection:
gradlew mavenLocal
ls -R build/maven-local/
Assemble Javdocs on a module:
gradlew -p lucene/core javadoc
ls lucene/core/build/docs
Assemble entire documentation (including javadocs):
gradlew documentation
ls lucene/documentation/build/site
Other validation and checks
===========================
Generate a report of dependencies with known OWASP vulnerabilities:
gradlew :dependencyCheckAnalyze
open ./build/reports/dependency-check-report.html