Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (38 loc) · 1016 Bytes

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 1016 Bytes

Contributing to Wherobots JDBC Driver

Development Setup

Prerequisites

  • Java 17 or later
  • Gradle 8.x (wrapper included)

Building

./gradlew build

Running Tests

./gradlew test

Running the Smoke Test

The smoke test connects to a real Wherobots session:

./gradlew runSmokeTest -Papikey=<your_api_key>

Releasing

Prerequisites

  1. An account on Sonatype's Central Portal with permissions to publish to the com.wherobots namespace
  2. A GnuPG key for signing artifacts, loaded in gpg-agent

Publishing a Release

  1. Update the version in lib/build.gradle
  2. Set up your credentials: 
    export OSSRH_USERNAME=<user token>
export OSSRH_PASSWORD=<secret key>
  3. Publish to Maven Central: 
    ./gradlew clean publishToCentralPortal
  4. Monitor the deployment at https://central.sonatype.com/publishing/deployments
  5. Create a git tag and GitHub release for the new version