From a1fe148103fab32cb276114991a66ea1e9169a8d Mon Sep 17 00:00:00 2001 From: Michael L Heuer Date: Thu, 7 Apr 2016 16:50:36 -0500 Subject: [PATCH] update release doc, fixes #987 --- scripts/release/README | 20 -------------------- scripts/release/README.md | 27 +++++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 20 deletions(-) delete mode 100644 scripts/release/README create mode 100644 scripts/release/README.md diff --git a/scripts/release/README b/scripts/release/README deleted file mode 100644 index 9abdeff9d4..0000000000 --- a/scripts/release/README +++ /dev/null @@ -1,20 +0,0 @@ -This document describes how to make an ADAM release. - -Setup your environment -1. Copy (or incorporate) the settings.xml file to ~/.m2/settings.xml -2. Request the ADAM packager private GPG key -3. Edit the username, password, etc in ~/.m2/settings.xml - -Once your environment is setup, you'll be able to do a release. - -Make sure that the CHANGES.md is up to date first by running, -`./scripts/changelog.sh | tee CHANGES.md` in the root of the ADAM project. - -From the project root directory, run `./scripts/release/release.sh`. -If you have any problems, run `./scripts/release/rollback.sh`. - -Once you've successfully published the release, you will need to -"close" and "release" it following the instructions at -https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage+Guide#SonatypeOSSMavenRepositoryUsageGuide-8.a.1.ClosingaStagingRepository - -Be sure to announce the release on the ADAM mailing list and Twitter (@bigdatagenomics). diff --git a/scripts/release/README.md b/scripts/release/README.md new file mode 100644 index 0000000000..bc546c47a0 --- /dev/null +++ b/scripts/release/README.md @@ -0,0 +1,27 @@ +Notes for release managers +--- + +This document describes how to make an ADAM release. + +Setup your environment +1. Copy (or incorporate) the settings.xml file to ```~/.m2/settings.xml``` +2. Request the ADAM packager private GPG key +3. Edit the username, password, etc in ```~/.m2/settings.xml``` + +Once your environment is setup, you'll be able to do a release. + +First update CHANGES.md with closed issues and closed and merged pull requests and commit to master. +Since version 0.18.2 this is a manual process, see issue #936 and e.g. commit 48e2930a4bb026928b31e5bef03b305f0dbeb41d. + +Then from the project root directory, run `./scripts/release/release.sh`. +If you have any problems, run `./scripts/release/rollback.sh`. + +Once you've successfully published the release, you will need to "close" and "release" it following the instructions at +http://central.sonatype.org/pages/releasing-the-deployment.html#close-and-drop-or-release-your-staging-repository + +After the release is rsynced to the Maven Central repository, confirm checksums match and verify signatures. + +Create a new pull request against [Homebrew Science](https://github.com/Homebrew/homebrew-science) for the new release version. +Often this will just require a version bump and checksum update. See e.g. https://github.com/Homebrew/homebrew-science/pull/3375. + +Finally, be sure to announce the release on the ADAM mailing list and Twitter (@bigdatagenomics). \ No newline at end of file