From c18b06ad0866f9a0f66479987e9c617aa41f2f15 Mon Sep 17 00:00:00 2001 From: Gabriel Ittner Date: Sat, 1 Feb 2020 14:04:35 +0100 Subject: [PATCH] update signing section of readme (#102) * update signing section of readme * Update README.md Co-Authored-By: Niklas Baudy * Update README.md Co-Authored-By: Niklas Baudy Co-authored-by: Niklas Baudy --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d0b57f7f..8735c229 100755 --- a/README.md +++ b/README.md @@ -112,8 +112,9 @@ __Note:__ To prevent looping behavior, especially in Kotlin projects / modules, ### Signing -The plugin supports signing all of your artifacts with GPG. This is a requirement when publishing to -Maven Central - our default behavior. Signing parameters can be configured via: +The plugin supports signing all of your release artifacts with GPG. This is a requirement when publishing to +Maven Central - our default behavior. Any version ending in `-SNAPSHOT` will never be signed. Signing parameters +can be configured via: ```groovy signing.keyId=12345678 @@ -121,9 +122,23 @@ signing.password=some_password signing.secretKeyRingFile=/Users/yourusername/.gnupg/secring.gpg ``` -It's best to place them inside your home directory, `$HOME/.gradle/gradle.properties`. +It's best to place them inside your home directory, `$HOME/.gradle/gradle.properties`. You can find more information +about these properties in [Gradle's documentaion](https://docs.gradle.org/current/userguide/signing_plugin.html#sec:signatory_credentials). -To disable signing you can set the `signing = false` on a target (see above). +It is possible to disable signing of release artifacts directly in your build scripts (takes precedence): + +```groovy +mavenPublish { + releaseSigningEnabled = false +} +``` + +Alternatively, you can use a Gradle property which is recommended if you only want to sign certain builds +or only build on certain machines. + +```groovy +RELEASE_SIGNING_ENABLED=false +``` ### Releasing