RUNBOOK.md

Runbook

This is the general purpose runbook for the project. Here you can find the scripts that you can use for common repetitive operations and also run them interactively.

Tip

You can run these commands interactively with Runme. Consider installing Runme locally, as a VS Code add on or as a browser extension to streamline the process.

General commands

# Build the whole project
./gradlew build

# Clean the artifacts from previous builds
./gradlew clean

# Clean the artifacts from previous builds, including external cached contents
# and test projects created on target platforms (GitHub, GitLab)
./gradlew deepClean

# Run all tests
./gradlew tests

# Run all unit tests
./gradlew unitTest

# Run all integration tests
./gradlew integrationTest

# Run all functional tests
./gradlew functionalTest

Documentation

export DOCUSAURUS_PORT=3000

# Start the Docusaurus development server
cd docs/main
npm run start -- --host 0.0.0.0 --port $DOCUSAURUS_PORT