The Teamscale Custom-Check Sample Repository

This repository is meant to serve as a starting point for developing custom checks for Teamscale. You can build your custom checks using either Gradle or Maven.

Build with Gradle

• Clone this repository.
• Run ./gradlew jar (Linux/macOS) or gradlew.bat jar (Windows).
• Copy the JAR from build/libs/teamscale-custom-check-sample.jar to the custom-checks/ folder in your Teamscale installation root.
• Restart Teamscale.
• You should now be able to see the sample check when creating a new Java analysis profile. It can be found inside the Bad Practice group.

Developing Custom Checks with IntelliJ IDEA

You can import the project into IntelliJ IDEA using File > Open. Then, when asked, select Open as: Gradle Project. When the import is finished, you will find the sample custom check (SampleCheck) in the src/main/java directory.

Developing Custom Checks with Eclipse

Use ./gradlew eclipse (Linux/macOS) or gradlew.bat eclipse (Windows) to create Eclipse project files. You can then import the project into Eclipse using File > Import > General > Existing Projects into Workspace. When the import is finished, you will find the sample custom check (SampleCheck) in the src/main/java directory.

Build with Maven

• Clone this repository.
• Run ./mvnw clean verify.
• Copy the JAR from target/teamscale-custom-check-sample.jar to the custom-checks/ folder in your Teamscale installation root.
• Restart Teamscale.
• You should now be able to see the sample check when creating a new Java analysis profile. It can be found inside the Bad Practice group.

Developing Custom Checks with IntelliJ IDEA

You can import the project into IntelliJ IDEA using File > Open. Then, when asked, select Open as: Maven Project. When the import is finished, you will find the sample custom check (SampleCheck) in the src/main/java directory.

Developing Custom Checks with Eclipse

You can import the project into Eclipse using File > Import > Maven > Existing Maven projects. When the import is finished, you will find the sample custom check (SampleCheck) in the src/main/java directory.

Documentation

Javadoc: http://cqse.github.io/teamscale-custom-check-sample

The Javadoc documentation also contains more sample checks which you can use as examples/base for your own checks.

API evolution / version updates of Teamscale

The custom-check API and thus any custom-check binaries are compatible between patch releases (e.g., 5.6.0 and 5.6.1). However, when updating to a new feature release (e.g., 5.6.x to 5.7.x), a rebuild of your custom checks against the latest custom-check API is recommended.

Get Help

Need help? Contact us at [email protected].