Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (53 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

79 lines (53 loc) · 2.2 KB

Developing sdk-java

This doc is intended for contributors to sdk-java (hopefully that's you!)

Note: All contributors also need to fill out the Temporal Contributor License Agreement before we can merge in any of your changes

Development Environment

  • Java 21+
  • Docker to run Temporal Server

Build

./gradlew clean build

Code Formatting

Code autoformatting is applied automatically during a full gradle build. Build the project before submitting a PR. Code is formatted using spotless plugin with google-java-format tool.

Commit Messages

Overcommit adds some requirements to your commit messages. We follow the Chris Beams guide to writing git commit messages. Read it, follow it, learn it, love it.

Running features tests in CI

For each PR we run the java tests from the features repo. This requires your branch to have tags. Without tags, the features tests in CI will fail with a message like

> Configure project :sdk-java
fatal: No names found, cannot describe anything.

This can be done resolved by running git fetch --tags on your branch. Note, make sure your fork has tags copied from the main repo.

Test and Build

Run a local temporal server with the temporal CLI:

temporal server start-dev

(If this does not work, see instructions for running the Temporal Server at https://github.com/temporalio/temporal/blob/master/README.md.)

Then run all the tests with:

./gradlew test

Build with:

./gradlew build

Note on Rosetta

Newer Apple Silicon macs do not ship with Rosetta by default, and the version of protoc-gen-rpc-java we use (1.34.1) does not ship Apple Silicon binaries.

So Gradle is set to hardcode the download of the x86_64 binaries on MacOS, but this depends on Rosetta to function. Make sure Rosetta is installed with

/usr/bin/pgrep oahd

which should return a PID of the Rosetta process. If it doesn't, you'll need to run

softwareupdate --install-rosetta

for builds to complete successfully.