Skip to content

Commit c3e4db0

Browse files
Release docs
1 parent 8f092e5 commit c3e4db0

File tree

1 file changed

+35
-19
lines changed

1 file changed

+35
-19
lines changed

RELEASE.md

Lines changed: 35 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
1-
### Releasing
1+
# Releasing
2+
3+
## Prerequisites
4+
5+
In the following please substitute the placeholders `<SOMETHING>` with concrete values.
6+
7+
### OSS Sonatype
28

39
See http://central.sonatype.org/pages/ossrh-guide.html
410

5-
Sonatype-Nexus specific maven configuration: `~/.m2/settings.xml`
6-
7-
```xml
8-
<settings>
9-
<servers>
10-
<server>
11-
<id>sonatype-nexus-snapshots</id>
12-
<username>your-jira-id</username>
13-
<password>your-jira-pwd</password>
14-
</server>
15-
<server>
16-
<id>sonatype-nexus-staging</id>
17-
<username>your-jira-id</username>
18-
<password>your-jira-pwd</password>
19-
</server>
20-
</servers>
21-
</settings>
11+
#### Signing
12+
13+
To configure jar signing, you need to have a gpg key.
14+
15+
* Get public key ID `gpg --list-keys --keyid-format SHORT`
16+
* Export key `gpg --keyring secring.gpg --export-secret-keys > ~/.gnupg/secring.gpg`
17+
* Add the following properties to `~/.gradle/gradle.properties`
18+
19+
```properties
20+
signing.keyId=<KEY-ID>
21+
signing.password=<PASSWORD>
22+
signing.secretKeyRingFile=<HOME-DIR>/.gnupg/secring.gpg
23+
```
24+
25+
#### Upload archives
26+
27+
Add the following properties to `~/.gradle/gradle.properties` (same credentials as for https://oss.sonatype.org):
28+
29+
```properties
30+
ossrhUsername=<USERNAME>
31+
ossrhPassword=<PASSWORD>
32+
```
33+
34+
Alternatively, you can pass the credentials as command line parameters:
35+
36+
```sh
37+
./gradlew release --info -PossrhUsername=<USERNAME> -PossrhPassword=<PASSWORD>
2238
```
2339

24-
Note: Detailed information about performing a release can be found in the SCM section.
40+
### OSS Sonatype Repository
2541

2642
## SCM
2743

0 commit comments

Comments
 (0)