Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
54 lines (38 loc) · 2.33 KB

DEVELOPMENT.md

File metadata and controls

54 lines (38 loc) · 2.33 KB

Development

  • Clone recursively or at least init and update the conventions-vclib/gradle-conventions-plugin submodule manually
  • Make sure you have the path to an Android SDK path properly set up in local.properties! Otherwise this project will fail to load.
  • If you are using a composite build, be sure to also setup an Android SDK path in signum/local.properties! Otherwise this project will also fail to load.

Publishing

Create a GPG key with gpg --gen-key, and export it with gpg --keyring secring.gpg --export-secret-keys > ~/.gnupg/secring.gpg. Be sure to publish it with gpg --keyserver keyserver.ubuntu.com --send-keys <your-key-id>. See also the information in the Gradle docs.

Create a user token for your Nexus account on https://s01.oss.sonatype.org/ (in your profile) to use as sonatypeUsername and sonatypePassword.

Configure your ~/.gradle/gradle.properties:

signing.keyId=<last-8-chars>
signing.password=<private-key-password>
signing.secretKeyRingFile=<path-of-your-secring>
sonatypeUsername=<user-token-name>
sonatypePassword=<user-token-password>

In addition, it is highly recommended to set the System property publishing.excludeIncludedBuilds to true, to build artefacts for publishing, which do no depend on included builds.

To run the pipeline from GitHub, export your GPG key with gpg --export-secret-keys --armor <keyid> | tee <keyid>.asc and set the following environment variables:

ORG_GRADLE_PROJECT_signingKeyId=<last-8-chars>
ORG_GRADLE_PROJECT_signingKey=<ascii-armored-key>
ORG_GRADLE_PROJECT_signingPassword=<private-key-password>
ORG_GRADLE_PROJECT_sonatypeUsername=<user-token-name>
ORG_GRADLE_PROJECT_sonatypePassword=<user-token-password>

Actually, these environment variables are read from the repository secrets configured on Github.

Publish with:

./gradlew clean publishToSonatype

To also release the artifacts to Maven Central run:

./gradlew clean publishToSonatype closeAndReleaseSonatypeStagingRepository

To publish locally for testing, one can skip the signing tasks:

./gradlew clean publishToMavenLocal -x signJvmPublication -x signKotlinMultiplatformPublication -x signIosArm64Publication -x signIosSimulatorArm64Publication -x signIosX64Publication