blob: bfc4434f4a0eee9a0ef06a72ea26fa8cedd7e84c [file] [log] [blame]
Pierre De Rop3a00a212015-03-01 09:27:46 +00001
2
3
4Apache Felix Dependency Manager Release Guide
5This document describes how to do a source release. It is based on the Release FAQ [1]
6
7Prerequisites
8=============
9
10To 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
19Before 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
24Creating a tagged version of the sources can be done directly through svn (replace r<n> by the actual release number, like "r1"):
25
26svn 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
28Staging a release candidate
29===========================
30
31Staging a release starts by checking out a tagged version of the sources (replace r<n> by the actual release number, like "r1"):
32
33svn co https://svn.apache.org/repos/asf/felix/releases/org.apache.felix.dependencymanager-r<n>
34
35The 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
38Use 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 Ropa20b7582015-03-05 07:30:49 +000047create the staging:
Pierre De Rop3a00a212015-03-01 09:27:46 +000048
49$ ./gradlew makeStaging (this will create ./release/staging/ directory)
50
51Then you sign archives by invoking the following task:
52
53$ ./gradlew signStaging
54
55You 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
56https://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
60Voting on the release
61=====================
62
63Start 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>>>
66To: "Felix Developers List" <dev@felix.apache.org>
67Subject: [VOTE] Release of Apache Felix Dependency Manager release r<n>
68
69Hi,
70
71We solved N issues in this release:
72http://issues.apache.org/jira/...
73
74There are still some outstanding issues:
75http://issues.apache.org/jira/...
76
77Staging repository:
78https://dist.apache.org/repos/dist/dev/felix/apache-felix-dependencymanager-r<n>/
79
80You can use this UNIX script to download the release and verify the signatures:
81http://svn.apache.org/repos/asf/felix/trunk/dependencymanager/release/check_staged_release.sh
82
83Usage:
84sh check_staged_release.sh r<n> /tmp/felix-staging
85
86This script, unlike the original Felix check_stage_release.sh, will download staging from https://dist.apache.org/repos/dist/dev/felix instead of
87http://repository.apache.org/content/repositories.
88
89
90Please vote to approve this release:
91
92[ ] +1 Approve the release
93[ ] -1 Veto the release (please provide specific comments)
94
95This vote will be open for 72 hours.
96<<<
97
98Promoting the release:
99=====================
100
101Move the artifacts from the development area to the final release location at
102https://dist.apache.org/repos/dist/release/felix by invoking the following target:
103
104$ ./gradlew promoteToRelease
105
Pierre De Ropa20b7582015-03-05 07:30:49 +0000106Then Edit the ./release/build.gradle script, increment the "ext.dmRelease" property, and commit.
107
Pierre De Rop3a00a212015-03-01 09:27:46 +0000108Cancelling 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