Pierre De Rop | 3a00a21 | 2015-03-01 09:27:46 +0000 | [diff] [blame] | 1 | |
| 2 | |
| 3 | |
| 4 | Apache Felix Dependency Manager Release Guide |
| 5 | This document describes how to do a source release. It is based on the Release FAQ [1] |
| 6 | |
| 7 | Prerequisites |
| 8 | ============= |
| 9 | |
| 10 | To create a release you must: |
| 11 | |
| 12 | * Have Subversion installed on your system; |
| 13 | * Have gpg installed on your system; |
| 14 | * Have a public key added to the keys file, and committed to [2] |
| 15 | * If you are using an http proxy, configure the following: |
| 16 | |
| 17 | export GRADLE_OPTS="-Dhttps.proxyHost=www.somehost.org -Dhttps.proxyPort=8080" |
| 18 | |
| 19 | Before you can start staging a release candidate, you must: |
| 20 | |
| 21 | * make sure there are no dependencies on snapshots/unreleased versions; |
| 22 | * create a tagged version of the sources in preparation of the release candidate. |
| 23 | |
| 24 | Creating a tagged version of the sources can be done directly through svn (replace r<n> by the actual release number, like "r1"): |
| 25 | |
| 26 | svn copy https://svn.apache.org/repos/asf/felix/trunk/dependencymanager https://svn.apache.org/repos/asf/felix/releases/org.apache.felix.dependencymanager-r<n> -m "Release of Apache Felix Dependency Manager r<n>" |
| 27 | |
| 28 | Staging a release candidate |
| 29 | =========================== |
| 30 | |
| 31 | Staging a release starts by checking out a tagged version of the sources (replace r<n> by the actual release number, like "r1"): |
| 32 | |
| 33 | svn co https://svn.apache.org/repos/asf/felix/releases/org.apache.felix.dependencymanager-r<n> |
| 34 | |
| 35 | The next step is to build/test the software and create the release/staging/ directory (where the source/jars will be packaged): |
| 36 | (replace r<n> by the actual release number, like "r1") |
| 37 | |
| 38 | Use a Java7 JDK |
| 39 | |
| 40 | $ cd org.apache.felix.dependencymanager-r<n> |
| 41 | $ ./gradlew rat |
| 42 | $ ./gradlew org.apache.felix.dependencymanager.annotation:jar |
| 43 | $ ./gradlew jar |
| 44 | $ ./gradlew test |
| 45 | $ ./gradlew check |
| 46 | |
Pierre De Rop | a20b758 | 2015-03-05 07:30:49 +0000 | [diff] [blame] | 47 | create the staging: |
Pierre De Rop | 3a00a21 | 2015-03-01 09:27:46 +0000 | [diff] [blame] | 48 | |
| 49 | $ ./gradlew makeStaging (this will create ./release/staging/ directory) |
| 50 | |
| 51 | Then you sign archives by invoking the following task: |
| 52 | |
| 53 | $ ./gradlew signStaging |
| 54 | |
| 55 | You can upload the archives and the signatures to our development area, which we use to stage this release candidate. This development area can be found at |
| 56 | https://dist.apache.org/repos/dist/dev/felix and adding files to it can be done using "svnpubsub" which is taken care of by the following target: |
| 57 | |
| 58 | $ ./gradlew commitToStaging |
| 59 | |
| 60 | Voting on the release |
| 61 | ===================== |
| 62 | |
| 63 | Start a vote on the dev@felix.apache.org list, for example (be sure to replace r<n> with the correct release number, like "r1"): |
| 64 | |
| 65 | >>> |
| 66 | To: "Felix Developers List" <dev@felix.apache.org> |
| 67 | Subject: [VOTE] Release of Apache Felix Dependency Manager release r<n> |
| 68 | |
| 69 | Hi, |
| 70 | |
| 71 | We solved N issues in this release: |
| 72 | http://issues.apache.org/jira/... |
| 73 | |
| 74 | There are still some outstanding issues: |
| 75 | http://issues.apache.org/jira/... |
| 76 | |
| 77 | Staging repository: |
| 78 | https://dist.apache.org/repos/dist/dev/felix/apache-felix-dependencymanager-r<n>/ |
| 79 | |
| 80 | You can use this UNIX script to download the release and verify the signatures: |
| 81 | http://svn.apache.org/repos/asf/felix/trunk/dependencymanager/release/check_staged_release.sh |
| 82 | |
| 83 | Usage: |
| 84 | sh check_staged_release.sh r<n> /tmp/felix-staging |
| 85 | |
| 86 | This script, unlike the original Felix check_stage_release.sh, will download staging from https://dist.apache.org/repos/dist/dev/felix instead of |
| 87 | http://repository.apache.org/content/repositories. |
| 88 | |
| 89 | |
| 90 | Please vote to approve this release: |
| 91 | |
| 92 | [ ] +1 Approve the release |
| 93 | [ ] -1 Veto the release (please provide specific comments) |
| 94 | |
| 95 | This vote will be open for 72 hours. |
| 96 | <<< |
| 97 | |
| 98 | Promoting the release: |
| 99 | ===================== |
| 100 | |
| 101 | Move the artifacts from the development area to the final release location at |
| 102 | https://dist.apache.org/repos/dist/release/felix by invoking the following target: |
| 103 | |
| 104 | $ ./gradlew promoteToRelease |
| 105 | |
Pierre De Rop | a20b758 | 2015-03-05 07:30:49 +0000 | [diff] [blame] | 106 | Then Edit the ./release/build.gradle script, increment the "ext.dmRelease" property, and commit. |
| 107 | |
Pierre De Rop | 3a00a21 | 2015-03-01 09:27:46 +0000 | [diff] [blame] | 108 | Cancelling the release |
| 109 | ====================== |
| 110 | |
| 111 | $ ./gradlew deleteFromStaging |
| 112 | |
| 113 | [1] http://www.apache.org/dev/release.html |
| 114 | [2] http://www.apache.org/dist/felix/KEYS |