This is an internal documentation. There is a good chance you’re looking for something else. See Disclaimer.

Build¶

Note

This documentation is currently limited to terminal commands. When using IDEA, feel free to use the built-in tools.

Development¶

Basic build command:

./gradlew build -x test

Not all changes can be built incrementally. A clean build is needed in such cases:

./gradlew clean build -x test

In particular, this is likely needed when changing to a different branch. clean will also ensure NPM dependency are refetched.

Production¶

Production builds:

export CI=1
export ORG_GRADLE_PROJECT_nice2_repo_username=${USERNAME}
export ORG_GRADLE_PROJECT_nice2_repo_password=${PASSWORD}
./gradle clean customer:${CUSTOMER_NAME}:build -x test -P buildForProduction=true

Note

CI=1

When this env. var. is set, npm is instructed to use the checked-in lock file. This prevents updated dependencies from breaking builds. See WEB-138.

⚠️ Always set this in CI/CD environments.

buildForProduction=true

Build in production mode. As of today, this is used to ensure website assets are built in production mode.

⚠️ Always set this in CI/CD environments.

ORG_GRADLE_PROJECT_nice2_repo_username=${USERNAME}

ORG_GRADLE_PROJECT_nice2_repo_password=**${PASSWORD}

When building locally, credentials to access the package registry are stored in ~/.gradle/grade.properties. However, in a CI/CD environment, these env. var. may be used instead. See also Repository Access.

customer:${CUSTOMER_NAME}:build

Limit build to given customer. For CI/CD, in particular, use this to reduce build time. Use build to build all customer modules.

Docker¶

See Build Nice Docker Image

Running¶

Development¶

Start Nice2:

./gradlew customer:${CUSTOMER}:bootRun -PmaxHeapSize='4G' --args='--spring.profiles.active=development --spring.output.ansi.enabled=ALWAYS'

Docker¶

See Start Nice2

Schema Upgrade (AKA DB Refactoring)¶

Development¶

Run schema upgrade:

./gradlew bootRun --build-cache -PmaxHeapSize='4G' -PjvmArgs='-Dch.tocco.nice2.disableSchemaModelStartupCheck=true' --args='--spring.profiles.active=update --spring.output.ansi.enabled=ALWAYS --ch.tocco.nice2.enableUpgradeMode=true --ch.tocco.nice2.enterprisesearch.disableStartup=true --ch.tocco.nice2.disableRoleSync=true --ch.tocco.nice2.disableLanguageSync=true --ch.tocco.nice2.disableBusinessUnitSync=true'

Docker¶

See Schema Upgrade

Tests¶

Run tests:

export CI=1
export ORG_GRADLE_PROJECT_nice2_repo_username=${USERNAME}
export ORG_GRADLE_PROJECT_nice2_repo_password=${PASSWORD}
./gradlew clean build

Omit -x test and test are run as part of the build.

Note