diff options
Diffstat (limited to '')
| -rw-r--r-- | site/trunk/site-publish/making-releases.html | 701 |
1 files changed, 701 insertions, 0 deletions
diff --git a/site/trunk/site-publish/making-releases.html b/site/trunk/site-publish/making-releases.html new file mode 100644 index 0000000000..7382bb66c3 --- /dev/null +++ b/site/trunk/site-publish/making-releases.html @@ -0,0 +1,701 @@ + +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE- 2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + + +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> + <HEAD> + <!-- generateKeywords macro --> + <META name="description" content="Apache Tuscany"> + <META name="keywords" content="apache, apache tuscany, tuscany, service, services, fabric, soa, service oriented architecture, sca, service component architecture, das, sdo, csa, ruby, opensource"> + <!-- generateKeywords macro end --> + + <LINK type="text/css" rel="stylesheet" href="http://tuscany.apache.org/stylesheets/default.css"> + <LINK rel="SHORTCUT ICON" href="https://cwiki.apache.org/confluence/display/TUSCANY/$images/favicon.ico"> + <TITLE>Apache Tuscany : Making releases</TITLE> + <META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD> + + <BODY onload="init()"> + <!-- topNav macro --> + <TABLE valign="top" border="0" cellspacing="0" cellpadding="0" width="100%" background="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg"> + <TR> + <TD valing="top" align="left"> + <A href="https://cwiki.apache.org/confluence/pages/viewpage.action?spaceKey=TUSCANY&title=$siteroot"><IMG src="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg" height="91" width="25" border="0"></A> + </TD> + <TD> + <A href="http://tuscany.apache.org/"><IMG src="http://tuscany.apache.org/images/TuscanyLogo.jpg" border="0"></A> + </TD> + + <TD width="100%"> + + </TD> + + <!-- Adds the edit page link to the top banner--> + <TD valign="bottom"> + <DIV style="padding: 2px 10px; margin: 0px;"> + <A href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=60576"> + <IMG src="http://tuscany.apache.org/images/notep_16.gif" height="16" width="16" border="0" align="absmiddle" title="Edit Page"></A> + </DIV> + </TD> + + </TR> + </TABLE> + <!-- topNav macro end --> + + <!-- breadCrumbs macro --> + <TABLE border="0" cellpadding="2" cellspacing="0" width="100%"> + <TR class="topBar"> + <TD align="left" valign="middle" class="topBarDiv" nowrap="true" width="100%"> + <A href="home.html" title="Apache Tuscany">Apache Tuscany</A> > <A href="home.html" title="Home">Home</A> > <A href="general-info.html" title="General Info">General Info</A> > <A href="" title="Making releases">Making releases</A> + </TD> + + <TD align="right" valign="middle" class="topBarDiv" align="left" nowrap="true"> + <A href="http://mail-archives.apache.org/mod_mbox/tuscany-user">User List</A> | <A href="http://mail-archives.apache.org/mod_mbox/tuscany-dev">Dev List</A> | <A href="http://issues.apache.org/jira/browse/Tuscany">Issue Tracker</A> + </TD> + </TR> + </TABLE> + <!-- breadCrumbs macro end --> + + + <TABLE border="0" cellpadding="0" width="100%" bgcolor="#FFFFFF"> + <TR> + <TD align="left" valign="top"> + + <!-- pageContent macro --> + <DIV id="PageContent"> + + <DIV class="pagecontent"> + <DIV class="wiki-content"> + <TABLE class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><TBODY><TR> +<TD class="confluenceTd" valign="top" width="15%"> +<DIV class="panel" style="background-color: #ECF4D1;border-color: #C3CDA1;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #C3CDA1;background-color: #C3CDA1;"><B>General</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="home.html" title="Home">Home</A><BR> +<A href="http://www.apache.org/licenses/LICENSE-2.0.html" class="external-link" rel="nofollow">License </A><BR> +<A href="tuscany-downloads-documentations.html" title="Tuscany Downloads & Documentations">Downloads</A><BR> +<A href="tuscany-downloads-documentations.html" title="Tuscany Downloads & Documentations">Documentation</A><BR> +<A href="tuscany-books-and-articles.html" title="Tuscany Books and Articles">Books and Articles</A><BR> +<A href="tuscany-dashboard.html" title="Tuscany Dashboard">Dashboard</A><BR> +<A href="issue-tracking.html" title="Issue Tracking">Found a Bug?</A><BR> +<A href="http://www.apache.org/foundation/sponsorship.html" class="external-link" rel="nofollow">Sponsorship </A><BR> +<A href="http://www.apache.org/foundation/thanks.html" class="external-link" rel="nofollow">Thanks </A><BR> +<A href="privacy-policy.html" title="Privacy Policy">Privacy Policy</A></P> +</DIV></DIV> +<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>Community</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="getting-involved.html" title="Getting Involved">Get Involved</A><BR> +<A href="mailing-lists.html" title="Mailing Lists">Mailing Lists</A><BR> +<A href="committers.html" title="Committers">Committers</A><BR> +<A href="chinese-portal.html" title="Chinese Portal">Chinese Portal </A> <SPAN class="image-wrap" style=""><IMG src="community.data/chinese.jpg" style="border: 0px solid black"></SPAN><BR> +<A href="projects-using-tuscany.html" title="Projects Using Tuscany">Powered By</A></P> +</DIV></DIV> +<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>Tuscany SCA</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="sca-overview.html" title="SCA Overview">SCA Overview</A><BR> +<A href="sca-java.html" title="SCA Java">SCA Java</A><BR> +<A href="sca-native.html" title="SCA Native">SCA Native</A><BR> +<A href="php-sca.html" title="PHP SCA">SCA PHP</A></P> +</DIV></DIV> + + +<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>Tuscany SDO</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="sdo-overview.html" title="SDO Overview">SDO Overview</A><BR> +<A href="sdo-java.html" title="SDO Java">SDO Java</A><BR> +<A href="sdo-cpp.html" title="SDO CPP">SDO C++</A><BR> +<A href="sdo-php.html" title="SDO PHP">SDO PHP</A></P> +</DIV></DIV> +<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>Tuscany DAS</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="das-overview.html" title="DAS Overview">DAS Overview </A><BR> +<A href="das-java.html" title="DAS Java">DAS Java</A><BR> +<A href="das-c.html" title="DAS C++">DAS C++ </A></P> +</DIV></DIV></TD> +<TD class="confluenceTd" valign="top" width="85%"> + +<H3><A name="Makingreleases-GettingReady"></A>Getting Ready</H3> + +<P><A href="setting-up-ssh.html" title="Setting up ssh">Setting up ssh</A></P> + +<P><A href="create-signing-key.html" title="Create signing key">Create signing key</A></P> + +<P><A href="get-hold-of-rat.html" title="Get hold of RAT">Get hold of RAT</A></P> + +<H3><A name="Makingreleases-UsefulResources"></A>Useful Resources</H3> + +<P><A href="http://incubator.apache.org/guides/releasemanagement.html#best-practice" class="external-link" rel="nofollow">Incubator release best practice </A><BR> +<A href="http://incubator.apache.org/incubation/Incubation_Policy.html" class="external-link" rel="nofollow">Incubator Policy </A><BR> +<A href="http://www.apache.org/dev/" class="external-link" rel="nofollow">ASF Developer Guide </A><BR> +<A href="http://www.apache.org/dev/release.html" class="external-link" rel="nofollow">ASF Release FAQ </A><BR> +<A href="http://www.apache.org/dev/release.html#license" class="external-link" rel="nofollow">ASF Release Licensing FAQ </A><BR> +<A href="http://www.apache.org/dev/release-signing.html" class="external-link" rel="nofollow">ASF Release Signing </A><BR> +<A href="http://www.apache.org/dev/new-committers-guide.html#pgp" class="external-link" rel="nofollow">ASF Comitters Guide </A><BR> +<A href="http://people.apache.org/~henkp/" class="external-link" rel="nofollow">Henk's ASF Key Guide </A><BR> +<A href="http://pgp.surfnet.nl/" class="external-link" rel="nofollow">Surfnet Key Server </A><BR> +<A href="http://pgp.mit.edu/" class="external-link" rel="nofollow">MIT Key Server </A><BR> +<A href="http://svn.apache.org/repos/asf/tuscany/java/etc/release-sca.sh" class="external-link" rel="nofollow">Raymond's release script</A></P> + +<H3><A name="Makingreleases-ReleaseReviewerCheckList"></A>Release Reviewer Check List</H3> + +<P><IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that all RELEASE-NOTES and READMEs etc have the right release number and date<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that the RAT output doesn't report missing or non-ASF licenses other than for files that can't have ASF licenses.<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that all files (that need it) have the ASF copyright and it's the right date<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that the LICENSE and NOTICE files appear at the top level of source distro<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that the LICENSE and NOTICE files appear at the top level of binary distro<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that the LICENSE and NOTICE files appear at the top level of all /maven modules that will be distributed (these are the tricky ones as they get copied when people add new modules)<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that LICENSE files have a copy of all third part licenses for the files in directories below them (jar name and version to which license relates must be clearly marked. Use the list from the distribution lib dir)<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that NOTICE files have a copy of all of the copyright statements for the files in directories below the. You have to go through all dependency jars/files that have been copied in and check<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that the signatures are in the right format<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that the signing key is in the KEYS file and in an external repo<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that there are no SNAPSHOT dependencies still in the distribution<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that there is no junk left in the distributions (.log, .tmp, .bak etc)<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that the distribution match the tag as far as possible. (Our NOTICE files have the module name dropped in automatically so don't match and we don't ship svg files)<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that the manifests in the jars that we produce have enough information (name of product and version. Scripts below should do this).<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that the project depends on the smallest number of versions of each third party jar<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that all samples compile and run from the command line and where appropriate operate correctly in Tomcat/WebSphere/Jetty/Geronimo<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check that all demos compile and run from the command line and where appropriate operate correctly in Tomcat/WebSphere/Jetty/Geronimo<BR> +<IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" height="16" width="16" align="absmiddle" alt="" border="0"> Check to make sure Javadocs are generated for APIs and SPIs.</P> + +<H3><A name="Makingreleases-ReleaseManagerReleaseProcess"></A>Release Manager Release Process</H3> + +<P>This page borrows many of the commands from <A href="http://svn.apache.org/repos/asf/tuscany/java/etc/release-sca.sh" class="external-link" rel="nofollow">Raymond's release script</A> but with a bit more explanation and a few extra useful commands. The commands here were taken from when release 1.1 RC3a was under preparation. Note that this document has been updated from experience gained with the SDO 1.1.1 release, which was the first release made after exiting incubation; as such, whilst the release names used in this document refer to an "incubating" version, the svn repository and the maven repository have been updated to the non incubating versions. It's also fair to say that it's unlikely that you will want to run all of these commands in sequence as you generally end up repeating sections as release preparation progresses.</P> + +<H4><A name="Makingreleases-Callforrelease"></A>Call for release</H4> + +<P>At some point someone in the community will call for a release based on the features and fixes that have been under development in the trunk. Typically the first stage in the release process is to decide on who is going to be the release manager, i.e. who is going to ensure that all the steps are taken to ensure a good release. This will typical involve someone volunteering and a vote on the dev list. The next thing is the create a branch where the code can be stabilized and testing can start on the release artifacts. It's useful to try and ensure that the code is complete as possible and that all the samples run before the branch is created. This removes the need for a lot of double fixing between the branch and the trunk.</P> + +<H4><A name="Makingreleases-Createthebranch"></A>Create the branch</H4> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +svn copy https:<SPAN class="code-comment">//svn.apache.org/repos/asf/tuscany/java/sca https://svn.apache.org/repos/asf/tuscany/branches/sca-java-1.1 -m <SPAN class="code-quote">"Branch <SPAN class="code-keyword">for</SPAN> 1.1"</SPAN></SPAN> +</PRE> +</DIV></DIV> + +<P>Once the branch is created the version number in trunk can be updated.</P> + +<H4><A name="Makingreleases-Fixupthebranchwork"></A>Fix up the branch work</H4> + +<P>First checkout the branch so that you can work on it. These commands assume that a local directory called "branches" is present.</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd branches +svn co https:<SPAN class="code-comment">//svn.apache.org/repos/asf/tuscany/branches/sca-java-1.1/ 1.1-RC3a</SPAN> +</PRE> +</DIV></DIV> + +<P>Remove all the files that are not going to be part of the release, test all the samples and check all of the LICENSE and NOTICE files.</P> + +<P>Check dependencies are as you would expect them to be. In particular check that we aren't depending on many different versions of third part jars. If we are this has the side effect of messing up the generated build files. If module A depends on x.jar v1.2 and module B depends on x.jar v1.3 then when a build file that is generated for a sample that only depends on module A the stated x.jar dependency will be v1.2. Of course the distribution build will make sure that only v1.3 is actually shipped and so the ant build will fail. (TODO - need better automation)</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd sca +mvn -o -Pdependencies -Dmaven.test.skip=<SPAN class="code-keyword">true</SPAN> +find . -name dependency.txt -exec cat '{}' >> deptotal.txt \; +</PRE> +</DIV></DIV> + +<P>or</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd sca +mvn dependency:tree +</PRE> +</DIV></DIV> + +<P>Use you favorite spreadsheet tool to open deptotal.txt and order on the first column to see across the project what dependencies we have on what libraries/versions.</P> + +<P>Once the branch is at the stage where a release candidate can be created for testing prepare to make a tag.</P> + +<DIV class="panelMacro"><TABLE class="noteMacro"><COLGROUP><COL width="24"><COL></COLGROUP><TR><TD valign="top"><IMG src="https://cwiki.apache.org/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></TD><TD><B>"Tip"</B><BR>When making changes to a branch or tag that are also relevant to the trunk, it's much easier to apply the changes to the trunk at the time, rather than wait and risk losing the changes. Svn provides a simple one line way to do this with the "svn merge" command. In the root directory of a checked out version of the trunk, if you run a command like the following ... + + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +svn merge -r 674473:674474 https:<SPAN class="code-comment">//svn.apache.org/repos/asf/tuscany/tags/java/sdo/1.1.1-RC2a/ .</SPAN> +</PRE> +</DIV></DIV> + + +<P>then that will apply the same edits as were made in the 674474 commit in the tag; merging them into your checked out version of the current trunk. The earlier you do this, the less likely that svn will present you with conflicts to resolve.</P></TD></TR></TABLE></DIV> + +<H4><A name="Makingreleases-CreateTag1.1RC3a"></A>Create Tag 1.1-RC3a</H4> + +<P>These commands assume that a local directory called "tags" is present.</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags +svn co https:<SPAN class="code-comment">//svn.apache.org/repos/asf/tuscany/branches/sca-java-1.1/ 1.1-RC3a</SPAN> +</PRE> +</DIV></DIV> + +<P>Notice that all we are doing here is just checking out the branch again. This allows any last minute fixes to be taken from the branch in subversion and allows the version numbers in the tag to be corrected without affecting the branch, assuming that more than one tag will be required to complete the release process.</P> + +<H4><A name="Makingreleases-Fixthereleasedates"></A>Fix the release dates</H4> + +<P>In various files under distribution/src/main/release the month of release is quoted. Fix this to be the expected release month.</P> + +<H4><A name="Makingreleases-Checkthenoticedates"></A>Check the notice dates</H4> + +<P>It's not clear what the policy for dates in notice files is currently. We have gone for the following...</P> + +<P>Copyright (c) 2005 - 2009 The Apache Software Foundation</P> + +<P>As the project moves forward we need to check that the last date matches the current year. If you need to change all the notice files here's a script</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">for</SPAN> i in `/usr/bin/find . -name <SPAN class="code-quote">"NOTICE"</SPAN>`; <SPAN class="code-keyword">do</SPAN> sed <SPAN class="code-quote">"s/Copyright (c) 2005 - 2008/Copyright (c) 2005 - 2009/g"</SPAN> $i >/tmp/tmp.notice; cp /tmp/tmp.notice $i; done +</PRE> +</DIV></DIV> + +<H4><A name="Makingreleases-ChangetheversionID"></A>Change the version ID</H4> + +<P>The "-SNAPSHOT" is removed from the end of the version string. This ensures that the only thing building with the release version number on your PC is the tag being tested.</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags/1.1-RC3a +<SPAN class="code-keyword">for</SPAN> i in `/usr/bin/find . -name <SPAN class="code-quote">"*.xml"</SPAN> -o -name <SPAN class="code-quote">"*.java"</SPAN>`; <SPAN class="code-keyword">do</SPAN> <SPAN class="code-keyword">if</SPAN> grep 1.3-SNAPSHOT $i>/dev/<SPAN class="code-keyword">null</SPAN>; then sed <SPAN class="code-quote">"s/1.3-SNAPSHOT/1.3/g"</SPAN> $i >/tmp/tmp.xml; cp /tmp/tmp.xml $i; fi; done +</PRE> +</DIV></DIV> + +<H4><A name="Makingreleases-GeneratetheRATreport"></A>Generate the RAT report</H4> + +<P>Create the report.</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags +java -jar C:\simon\apps\rat-0.5.1\rat-0.5.1.jar 1.1-RC3a > rat-1.1-RC3a.txt +</PRE> +</DIV></DIV> + +<P>Copy the report up onto the staging repo. You should of course check the report at this stage.</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +scp rat-1.1-RC3a.txt slaws@people.apache.org:public_html/tuscany/1.1-RC3a +</PRE> +</DIV></DIV> + +<DIV class="panelMacro"><TABLE class="noteMacro"><COLGROUP><COL width="24"><COL></COLGROUP><TR><TD valign="top"><IMG src="https://cwiki.apache.org/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></TD><TD><B>"Tip"</B><BR>If you need to regenerate the RAT report after you have started on the steps that follow run "mvn clean" first to avoid complains about the files under target folders</TD></TR></TABLE></DIV> + +<H4><A name="Makingreleases-Buildfromtoplevel"></A>Build from top level</H4> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags/1.1-RC3a +mvn -o clean install +</PRE> +</DIV></DIV> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags/1.1-RC3a/demos +mvn -fae -o clean install +</PRE> +</DIV></DIV> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags/1.1-RC3a/tutorial +mvn -fae -o clean install +</PRE> +</DIV></DIV> + + +<H4><A name="Makingreleases-Builddistribution"></A>Build distribution</H4> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags/1.1-RC3a/distribution +mvn -o clean install +</PRE> +</DIV></DIV> + +<P>Check that the "all" jar is in place as with some JDKs this step fails intermittently</P> + +<H4><A name="Makingreleases-Copythedistributiontosomewhereandtryit"></A>Copy the distribution to somewhere and try it</H4> + +<P>Try all the samples/demos</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +ant run +</PRE> +</DIV></DIV> + +<P>and</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +ant build +ant run +</PRE> +</DIV></DIV> + +<P>The war samples are currently to be tested with</P> + +<UL class="alternate" type="square"> + <LI>Tomcat 5.5.20 and Tomcat 6.0.14</LI> + <LI>Jetty 6.1.3</LI> + <LI>Geronimo 2.0.2 Tomcat6 jee5</LI> + <LI>WebSphere 6.1 fix pack 9+</LI> +</UL> + + +<P>Clean you local repo of SCA modules and compile the source distro and run some samples to</P> + +<P>Check for copyrights in the code to ensure that are what you are expecting</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +grep -iR --exclude=LICENSE --exclude=NOTICE Copyright * | awk '{<SPAN class="code-keyword">if</SPAN> (!match($0, <SPAN class="code-quote">".+ASF.+"</SPAN>)) {print $0}}' +</PRE> +</DIV></DIV> + +<P>check all the NOTICE files</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">for</SPAN> i in `find . -name NOTICE`; <SPAN class="code-keyword">do</SPAN> echo XXXXXXXXXXXXXXXXXXXXXXXXXXXX; echo $i; cat $i; done > ../tmp +</PRE> +</DIV></DIV> + +<P>Check for any SNAPSHOTS left in by mistake</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +grep -r --include=*.xml SNAPSHOT * +</PRE> +</DIV></DIV> + +<P>Check the LICENSE file against what is provided in the distributions. There is no automation for this bit.</P> + +<P>Check that all jars in the distribution\lib is mentioned on the binary LICENSE</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">for</SPAN> fn in *.jar; <SPAN class="code-keyword">do</SPAN> <SPAN class="code-keyword">if</SPAN> grep -q $fn ../LICENSE; then <SPAN class="code-quote">"$fn"</SPAN>; <SPAN class="code-keyword">else</SPAN> <SPAN class="code-quote">"$fn NOT present"</SPAN>; fi; done +</PRE> +</DIV></DIV> + +<P>For 2.x this is</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">for</SPAN> fn in `find . -name <SPAN class="code-quote">"*.jar"</SPAN> -printf <SPAN class="code-quote">"%f\n"</SPAN>`; <SPAN class="code-keyword">do</SPAN> <SPAN class="code-keyword">if</SPAN> grep -q $fn ../LICENSE; then <SPAN class="code-quote">"-"</SPAN>; <SPAN class="code-keyword">else</SPAN> <SPAN class="code-quote">"$fn NOT present"</SPAN>; fi; done; +</PRE> +</DIV></DIV> + +<P>And check that all jars that are mentioned are present</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">for</SPAN> fn in `awk '/.jar/ {<SPAN class="code-keyword">if</SPAN> (match($0,<SPAN class="code-quote">"[a-zA-Z0-9._-]+[.]jar"</SPAN>)) {print substr($0, RSTART,RLENGTH) } }' ../LICENSE`; <SPAN class="code-keyword">do</SPAN> <SPAN class="code-keyword">if</SPAN> ls | grep -q $fn; then echo <SPAN class="code-quote">"$fn"</SPAN>;<SPAN class="code-keyword">else</SPAN> echo <SPAN class="code-quote">">>> $fn NOT present"</SPAN>; fi; done +</PRE> +</DIV></DIV> + +<P>For 2.x this is</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">for</SPAN> fn in `awk '/.jar/ {<SPAN class="code-keyword">if</SPAN> (match($0,<SPAN class="code-quote">"[a-zA-Z0-9._-]+[.]jar"</SPAN>)) {print substr($0, RSTART,RLENGTH) } }' ../LICENSE`; <SPAN class="code-keyword">do</SPAN> <SPAN class="code-keyword">if</SPAN> ls * | grep -q $fn; then echo <SPAN class="code-quote">"-"</SPAN>;<SPAN class="code-keyword">else</SPAN> echo <SPAN class="code-quote">">>> $fn NOT present"</SPAN>; fi; done +</PRE> +</DIV></DIV> + +<P>Check for junk included by accident</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> + find . -name log -print + find . -name work -print + find . -name lck -print + find . -name activemq-data -print + find . -name temp -print + find . -name tmp -print +</PRE> +</DIV></DIV> + +<P>Once you are happy with the release artifacts you can sign them and make them available for review.</P> + +<H4><A name="Makingreleases-Signtheartifacts"></A>Sign the artifacts</H4> + +<P>Linux</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags/1.1-RC3a/distribution/target +<SPAN class="code-keyword">for</SPAN> i in *.zip *.gz; <SPAN class="code-keyword">do</SPAN> gpg --output $i.asc --detach-sig --armor $i; done +<SPAN class="code-keyword">for</SPAN> i in *.zip *.gz; <SPAN class="code-keyword">do</SPAN> openssl md5 -hex $i | sed 's/MD5(\([^)]*\))= \([0-9a-f]*\)/\2 *\1/' > $i.md5; done +</PRE> +</DIV></DIV> + +<P>Windows:</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">for</SPAN> %A in (*.zip) <SPAN class="code-keyword">do</SPAN> gpg --output %A.asc --detach-sig --armor %A +<SPAN class="code-keyword">for</SPAN> %A in (*.gz) <SPAN class="code-keyword">do</SPAN> gpg --output %A.asc --detach-sig --armor %A +<SPAN class="code-keyword">for</SPAN> %A in (*.zip) <SPAN class="code-keyword">do</SPAN> gpg --print-md md5 %A > %A.md5 +<SPAN class="code-keyword">for</SPAN> %A in (*.gz) <SPAN class="code-keyword">do</SPAN> gpg --print-md md5 %A > %A.md5 +</PRE> +</DIV></DIV> + +<P>The commands above should produce artifacts of an appropriate format, as follows.</P> + +<P>md5 should look like</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> + 8fb7cb398063ed0dffa414168468fffc *apache-tuscany-sca-1.1-incubating.zip +</PRE> +</DIV></DIV> + +<P>asc should look like</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +-----BEGIN PGP SIGNATURE----- +Version: GnuPG v1.4.5 (Cygwin) + +iD8DBQBHnLGGE8fTrnkHPxIRAqPmAJ4tOR6W663FKCXHPi1GlLBWDyZwJgCeMqbb +68DOq0YsU/O7kJsBHuZXhJw= +=elh0 +-----END PGP SIGNATURE----- +</PRE> +</DIV></DIV> + +<P>Also you now need to sign the jars in the Eclipse update site.</P> + +<P>cd to both plugins and features and run:</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags/1.1-RC3a/distribution/target/apache-tuscany-sca-<releasenum>-updatesite.dir/tuscany-sca-<releasenum>-updatesite/plugins +<SPAN class="code-keyword">for</SPAN> i in *.jar; <SPAN class="code-keyword">do</SPAN> gpg --output $i.asc --detach-sig --armor $i; done +<SPAN class="code-keyword">for</SPAN> i in *.jar; <SPAN class="code-keyword">do</SPAN> openssl md5 -hex $i | sed 's/MD5(\([^)]*\))= \([0-9a-f]*\)/\2 *\1/' > $i.md5; done +cd ../features +<SPAN class="code-keyword">for</SPAN> i in *.jar; <SPAN class="code-keyword">do</SPAN> gpg --output $i.asc --detach-sig --armor $i; done +<SPAN class="code-keyword">for</SPAN> i in *.jar; <SPAN class="code-keyword">do</SPAN> openssl md5 -hex $i | sed 's/MD5(\([^)]*\))= \([0-9a-f]*\)/\2 *\1/' > $i.md5; done +</PRE> +</DIV></DIV> + + +<P>And then sign site.xml in the top level of the updatesite directory</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd .. +<SPAN class="code-keyword">for</SPAN> i in *.xml; <SPAN class="code-keyword">do</SPAN> gpg --output $i.asc --detach-sig --armor $i; done +<SPAN class="code-keyword">for</SPAN> i in *.xml; <SPAN class="code-keyword">do</SPAN> openssl md5 -hex $i | sed 's/MD5(\([^)]*\))= \([0-9a-f]*\)/\2 *\1/' > $i.md5; done +</PRE> +</DIV></DIV> + +<H4><A name="Makingreleases-Puttheartifactsupinyourhomedirectoryonpeople.apache.org"></A>Put the artifacts up in your home directory on people.apache.org</H4> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags/1.1-RC3a/distribution/target +scp *.asc slaws@people.apache.org:public_html/tuscany/1.1-RC3a +scp *.md5 slaws@people.apache.org:public_html/tuscany/1.1-RC3a +scp *.zip slaws@people.apache.org:public_html/tuscany/1.1-RC3a +scp *.gz slaws@people.apache.org:public_html/tuscany/1.1-RC3a +</PRE> +</DIV></DIV> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags/1.1-RC3a/distribution/target/apache-tuscany-sca-<releasenum>-updatesite.dir +scp -r * slaws@people.apache.org:public_html/tuscany/1.1-RC3a +</PRE> +</DIV></DIV> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags/1.1-RC3a/distribution/src/main/release +scp RELEASE_NOTES slaws@people.apache.org:public_html/tuscany/1.1-RC3a +scp CHANGES slaws@people.apache.org:public_html/tuscany/1.1-RC3a +</PRE> +</DIV></DIV> + +<H4><A name="Makingreleases-Checkpermissionsonthefiles"></A>Check permissions on the files</H4> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +chmod 644 *.zip +chmod 644 *.gz +chmod 644 *.txt +</PRE> +</DIV></DIV> + +<H4><A name="Makingreleases-Deploythemavenartifacts"></A>Deploy the maven artifacts</H4> + +<P>Note below that the reference to "apache.incubator" in the "id" part of the -DaltDeploymentRepository argument to the maven deploy plugin is simply an identifier relating to a stanza in your local maven repo's settings.xml file. Note that also if you use ssh authentication by referencing a file containing your private key from the settings.xml file, then be sure to use a file in open ssh format. People who have followed the apache <A href="http://www.apache.org/dev/user-ssh-windows.html" class="external-link" rel="nofollow">instructions for creating ssh keys on Windows</A> with putty will probably not have created open ssh format files. You can however convert your .ppk file to the open ssh forrmat by loading it into puttygen and using the conversion menu.</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags/1.1-RC3a +mvn -N -DaltDeploymentRepository=apache.incubator::<SPAN class="code-keyword">default</SPAN>::scp:<SPAN class="code-comment">//people.apache.org/home/slaws/public_html/tuscany/1.1-RC3a/maven install gpg:sign deploy:deploy -Dgpg.passphrase= +</SPAN> +cd tools +mvn clean +mvn -DaltDeploymentRepository=apache.incubator::<SPAN class="code-keyword">default</SPAN>::scp:<SPAN class="code-comment">//people.apache.org/home/slaws/public_html/tuscany/1.1-RC3a/maven install gpg:sign deploy:deploy -Dgpg.passphrase= +</SPAN> +cd modules +mvn clean +mvn -DaltDeploymentRepository=apache.incubator::<SPAN class="code-keyword">default</SPAN>::scp:<SPAN class="code-comment">//people.apache.org/home/slaws/public_html/tuscany/1.1-RC3a/maven install gpg:sign deploy:deploy -Dgpg.passphrase= +</SPAN> +NOTE:Remove non jar artifacts from stage repo +</PRE> +</DIV></DIV> + +<H4><A name="Makingreleases-Deploythealljar"></A>Deploy the all jar</H4> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd tags/1.1-RC3a/distribution/bundle/target +mvn gpg:sign-and-deploy-file -DgroupId=org.apache.tuscany.sca -DartifactId=tuscany-sca-all -Dversion=1.1-incubating -Dpackaging=jar -Dfile=tuscany-bundle-1.1-incubating.jar -DrepositoryId=apache.incubator -Durl=scp:<SPAN class="code-comment">//<userid@>people.apache.org/home/slaws/public_html/tuscany/1.1-RC3a/maven -Dkeyname=slaws -Dpassphrase=</SPAN> +</PRE> +</DIV></DIV> + +<P><IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/warning.gif" height="16" width="16" align="absmiddle" alt="" border="0"> I have to go in and sign the pom for the all jar manually as it didn't happen automatically?</P> + +<H4><A name="Makingreleases-CheckthattheMavenartifactswork"></A>Check that the Maven artifacts work</H4> + +<P>Point you maven build at your p.a.o dir as a temporary mirror, for example, add mirror element to the settings.xml file (usually found at .m2/settings)</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> + <mirrors> + <mirror> + <id>ant.staging</id> + <url>http:<SPAN class="code-comment">//people.apache.org/~slaws/tuscany/1.1-RC3a/maven</url> +</SPAN> <mirrorOf>apache.incubator</mirrorOf> + </mirror> + </mirrors> +</PRE> +</DIV></DIV> + +<P>Clean your local SCA artifacts and use maven to compile samples and see if they run.</P> + +<H4><A name="Makingreleases-Checkinthetag"></A>Check in the tag</H4> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +svn copy 1.1-RC3a https:<SPAN class="code-comment">//svn.apache.org/repos/asf/tuscany/tags/java/sca/1.1-RC3a/ -m <SPAN class="code-quote">"Tag <SPAN class="code-keyword">for</SPAN> 1.1-RC3a"</SPAN></SPAN> +</PRE> +</DIV></DIV> + +<H4><A name="Makingreleases-Startvoting"></A>Start voting</H4> + +<P>The PPMC will vote first. This may give rise to a new release candidate being required. If so you need to go back and start at the "Create Tag" step but using the next RC number.</P> + +<P>Once the PPMC vote is complete the vote is moved across to the IPMC. Once all the votes are complete the artifacts that have been voted on can be release.</P> + + +<H4><A name="Makingreleases-Onceallthevotingiscomplete"></A>Once all the voting is complete</H4> + +<P>Copy the artifacts from your directory on people.apache.org to:</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +/www/www.apache.org/dist/tuscany/java/sca/1.3.2 +</PRE> +</DIV></DIV> + +<P>except for the tuscany-sca-<releasenum>-updatesite-publish directory. The contents of this directory should be checked into svn under:</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +https:<SPAN class="code-comment">//svn.apache.org/repos/asf/tuscany/site/trunk/site-publish/updatesite/java/sca/<releasenum></SPAN> +</PRE> +</DIV></DIV> + +<P>Also check that the KEYS file is up to date.</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +/www/www.apache.org/dist/tuscany +</PRE> +</DIV></DIV> + +<H4><A name="Makingreleases-Copythestagingrepototheliverepo"></A>Copy the staging repo to the live repo</H4> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +mvn stage:copy -Dsource=<SPAN class="code-quote">"http:<SPAN class="code-comment">//people.apache.org/~slaws/tuscany/1.1-RC3a/maven"</SPAN> -Dtarget=<SPAN class="code-quote">"scp://<userid@>people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository"</SPAN> -Dversion=1.1</SPAN> +</PRE> +</DIV></DIV> + +<P>You'll need the maven stage plugin to do this. Since maven-stage-plugin is not published, the release manager should checkout the source for the plugin and build it.</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +http:<SPAN class="code-comment">//svn.apache.org/repos/asf/maven/plugins/trunk/maven-stage-plugin/</SPAN> +</PRE> +</DIV></DIV> + +<P>Or, instead of using the Maven stage plugin just manually copy the artifacts there:</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cp -p -v -R sca/ /x1/www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/tuscany/sca +</PRE> +</DIV></DIV> + +<H4><A name="Makingreleases-Checkthepermissionsintherepo"></A>Check the permissions in the repo</H4> + +<P>There is a script in the SNAPSHOT report that sets the permissions correctly.</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +cd /www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/tuscany/sca +/www/people.apache.org/repo/m2-snapshot-repository/fix-permissions.sh +</PRE> +</DIV></DIV> + +<H4><A name="Makingreleases-Copythereleasecandidatetagtothefinaltagname."></A>Copy the release candidate tag to the final tag name.</H4> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +svn copy https:<SPAN class="code-comment">//svn.apache.org/repos/asf/tuscany/tags/java/sca/1.1-RC3a/ https://svn.apache.org/repos/asf/tuscany/tags/java/sca/1.1 -m <SPAN class="code-quote">"Copy 1.1-RC3a tag as 1.1"</SPAN></SPAN> +</PRE> +</DIV></DIV></TD></TR></TBODY></TABLE> + </DIV> + </DIV> + </DIV> + <!-- pageContent macro end --> + + </TD> + </TR> + </TABLE> + + <!-- footer macro --> + <SCRIPT src="http://www.google-analytics.com/urchin.js" type="text/javascript"> + </SCRIPT> + <SCRIPT type="text/javascript"> + _uacct = "UA-1174707-5"; + urchinTracker(); + </SCRIPT> + + <A href="http://www.statcounter.com/" target="_blank"><IMG src="http://c26.statcounter.com/counter.php?sc_project=2619156&java=0&security=94bd7e7d&invisible=0" alt="website stats" border="0"></A> + + <DIV class="footer"> + Copyright � 2003-2012, The Apache Software Foundation </BR> + Apache Tuscany and the Apache Tuscany project logo are trademarks of The Apache Software Foundation. + </DIV> + <!-- footer macro end --> + + </BODY> +</HTML> |