The halm-rest-client-api is the starting point for building a complete standalone Java client that can be used to directly interact with the Helix ALM REST API. Learn more about Helix ALM.
The halm-rest-client-api is used by the Helix ALM Jenkins plugin to submit test results to the Helix ALM REST API. See the Helix ALM help for information about using the plugin.
Maintained by Perforce Software.
- Helix ALM 2022.2 Server or later
- Helix ALM REST API 2022.2 or later. Installed with the Helix ALM Server.
The halm-rest-client is a community supported project and is not officially supported by Perforce.
Pull requests and issues are the responsibility of the project's moderator(s); this may be a vetted individual or team with members outside of the Perforce organization. Perforce does not officially support these projects, therefore all issues should be reported and managed via GitHub (not via Perforce's standard support process).
To build, use:
./gradlew.bat build
When publishing, update currentVersion in the local project's gradle.properties file.
We follow semantic versioning for Major - Minor - Patch:
- Major = Breaking
- Minor = Additive
- Patch = Bugfix
This project has two test modes:
- ./gradlew.bat test
- ./gradlew.bat integrationTest
Runs the build in unit tests.
Runs a series of integration tests with the Helix ALM REST API. This expects a Helix ALM REST API and Helix ALM Server to be running, and the Helix ALM Server to have the sample projects loaded.