From 9e0a356079281504138e8aa2b519fa28822fbcff Mon Sep 17 00:00:00 2001 From: vruano Date: Fri, 20 Oct 2017 16:29:30 -0400 Subject: [PATCH] Adds pointer to the Picard project instructions to set-up sonatype and gpg that are needed to succeed making a release Closes #16. --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 62d1e1f..d0ea26a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ It allows Java code to call Heng Li's bwa mem aligner. To build you'll need gmake, git, gcc, and Java 8. -To build and install a snapshot locally: +#### To build and install a snapshot locally: ``` ./gradlew install @@ -14,14 +14,19 @@ To build and install a snapshot locally: This will work for testing but will only include a native library for your system. -To upload a snapshot from a Broad Institute OSX machine with both OSX and Linux binaries: +#### To upload a snapshot from a Broad Institute OSX machine with both OSX and Linux binaries: ``` commit your changes and push your branch to github scripts/build_both_dylib_and_so.sh ./gradlew uploadArchives printVersion ``` -To upload to maven central +#### To upload to maven central + +First follow the one-time setup instruction post on the [Picard project Wiki page](https://github.com/broadinstitute/picard/wiki/How-to-release-Picard#one-time-setup-tasks). You can ignore the last part about setting up sudo rights on picard02. + +Then do the following: + ``` commit your changes and push your branch to github git tag -a -s @@ -29,8 +34,20 @@ git tag -a -s scripts/build_both_dylib_and_so.sh ./gradlew uploadArchive -Drelease=true ``` +Then you need to finalize the release to maven central: + + * Go to [https://oss.sonatype.org/#stagingRepositories](https://oss.sonatype.org/#stagingRepositories), logging in if necessary. If you don't see anything, click "refresh". + + * Find the release you just uploaded. It will probably be at the bottom with a name like comgithubbroadinstitute-1027, with your user ID listed as owner. + + * Check the box next to your release, then select "close". Press the refresh button repeatedly until it updates and its status says "closed". + + * Select your release again and click "release". Select the box to "automatically drop" in the pop-up confirmation dialog. + +It may take ~30-180 minutes for the new release to show up on the maven central. + +#### To use this JNI binding on another architecture for which we don't provide a binary: -To use this JNI binding on another architecture for which we don't provide a binary: Go into ```src/main/c```. Modify the Makefile to produce a library name appropriate to your system. Type ```make``` (you'll need gmake, git, and gcc).