Skip to content

Commit e53c98b

Browse files
committed
docs(release): Update release documentation
1 parent b1bc8b4 commit e53c98b

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

RELEASE.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,20 @@ If you are not familiar with Sonatype and/or the maven release process please re
1616
* Install GPG, and create a public key. More info: http://central.sonatype.org/pages/working-with-pgp-signatures.html
1717

1818
### Releasing
19-
After the `master` branch successfully builds from the release changes, perform a release deployment to OSSRH (Staging) with:
19+
As part of your PR into `master` for a release, make a commit updating version number strings across the SDK. To do this, we use [bumpversion](https://github.com/peritus/bumpversion).
20+
21+
To use `bumpversion`, simply run the following command with the proper semantic version for your desired release:
2022
```bash
21-
`gradle release`
23+
bumpversion major|minor|patch
2224
```
23-
You will have to answer prompts for versions and tags. That will tag and commit a new version into your repository automatically.
24-
25-
### Manually releasing
2625

27-
The above instructions should work, but we've run into situations where the archive uploading through CI has failed because IP changes caused multiple staging repositories to be created in Sonatype, each with different pieces of the full set of artifacts. If this happens, the repositories won't be able to be closed and released on the Sonatype website.
26+
After you've merged your PR and After the `master` branch successfully builds from the release changes, check out the `master` branch and perform a release deployment to OSSRH (Staging) with:
27+
```bash
28+
gradle release
29+
```
30+
You will have to answer prompts for versions and tags. That will tag and commit a new version into your repository automatically.
2831

29-
Uploading the archives locally with the following command solves this problem:
32+
After the above commits pass, `git checkout` the new tag branch for your release. In that branch, execute the following command:
3033

3134
```bash
3235
./gradlew uploadArchives -Psigning.keyId=<keyId> -Psigning.password=<keyPassword> -Psigning.secretKeyRingFile=<pathToKeyRingFile> -PossrhUsername=<sonatypeUsername> -PossrhPassword=<sonatypePassword>
@@ -44,4 +47,4 @@ gpg --export-secret-keys -o <outputFilename>.gpg
4447
- `-PossrhUsername`: Your Sonatype username
4548
- `-PossrhPassword`: Your Sonatype password
4649

47-
Assuming this command works properly, you should be able to then log into Sonatype and close and release the repository as usual.
50+
Assuming this command works properly, you should be able to then log into Sonatype and close and release the repository.

0 commit comments

Comments
 (0)