Skip to content

Commit

Permalink
update signing section of readme (#102)
Browse files Browse the repository at this point in the history
* update signing section of readme

* Update README.md

Co-Authored-By: Niklas Baudy <niklas.baudy@vanniktech.de>

* Update README.md

Co-Authored-By: Niklas Baudy <niklas.baudy@vanniktech.de>

Co-authored-by: Niklas Baudy <niklas.baudy@vanniktech.de>
  • Loading branch information
gabrielittner and vanniktech committed Feb 1, 2020
1 parent 4a0de85 commit c18b06a
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,18 +112,33 @@ __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
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

Expand Down

0 comments on commit c18b06a

Please sign in to comment.