Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 2.07 KB

developer_guide.md

File metadata and controls

71 lines (49 loc) · 2.07 KB
Raw

Developer Guide

Using PortMapper as a library

PortMapper is available as a Maven dependency at Maven Central. Use the following coordinates:

  • Gradle: com.github.kaklakariada:portmapper:2.2.3

  • Maven:

    <dependency>
  <groupId>com.github.kaklakariada</groupId>
  <artifactId>portmapper</artifactId>
  <version>2.2.3</version>
</dependency>

Important: The version published to Maven Central is intended to be used as a library in other programs, not as a standalone program. If you don't know what this means you probably want to download UPnP PortMapper from SourceForge.

Building PortMapper

Build PortMapper on the command line:

git clone https://github.com/kaklakariada/portmapper.git
cd portmapper
./gradlew build
java -jar build/libs/portmapper-*.jar

Generate license header for added files

./gradlew licenseFormat

Check if dependencies are up-to-date

./gradlew dependencyUpdates

Publish to Maven Central

  1. Add the following to your ~/.gradle/gradle.properties:

    ossrhUsername=<your maven central username>
ossrhPassword=<your maven central passwort>

signing.keyId=<gpg key id (last 8 chars)>
signing.password=<gpg key password>
signing.secretKeyRingFile=<path to secret keyring file>

  2. Increment version number in build.gradle and README.md, commit and push.

  3. Optional: run the following command to do a dry-run:

    ./gradlew clean check build publishToSonatype closeSonatypeStagingRepository --info

  4. Run the following command to publish to Maven Central:

    ./gradlew clean check build publishToSonatype closeAndReleaseSonatypeStagingRepository --info

  5. Create a new release on GitHub.

  6. After some time the release will be available at Maven Central.