<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="robots" content="index,follow"/>
<title>AirRAC: Make a new release</title>
<link rel="shortcut icon" href="favicon.ico">
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="airrac.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-24983440-1']);
_gaq.push(['_setDomainName', 'none']);
_gaq.push(['_setAllowLinker', true]);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table width="100%">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname"><a href="http://airrac.sourceforge.net"><img height="45px" alt="AirRAC Logo" src="airrac_logo.png"></a>
 <span id="projectnumber">0.2.1</span>
</div>
<div id="projectbrief">C++ Simulated Revenue Accounting (RAC) System Library</div>
</td>
<!-- begin SOURCEFORGE_CUSTOM-->
<td>
<div id="sflogo"><a href="http://airrac.sourceforge.net"><img height="45px" alt="SourceForge Logo" src="sfx_logo.png"></a></div>
</td>
<!-- end SOURCEFORGE_CUSTOM-->
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('howto_release.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">Make a new release </div> </div>
</div>
<div class="contents">
<div class="textblock"><h2><a class="anchor" id="description"></a>
Introduction</h2>
<p>This document describes briefly the recommended procedure of releasing a new version of AirRAC using a Linux development machine and the SourceForge project site.</p>
<p>The following steps are required to make a release of the distribution package.</p>
<h2><a class="anchor" id="initialisation"></a>
Initialisation</h2>
<p>Clone locally the full <a href="http://airrac.git.sourceforge.net/git/gitweb.cgi?p=airrac/airrac;a=tree;h=refs/heads/trunk;hb=trunk">Git project</a>: </p>
<div class="fragment"><pre class="fragment">
cd ~
mkdir -p dev/sim
cd ~/dev/sim
git clone git://airrac.git.sourceforge.net/gitroot/airrac/airrac airracgit
cd airracgit
git checkout trunk
</pre></div><h2><a class="anchor" id="branch_creation"></a>
Branch creation</h2>
<p>Create the branch, on your local clone, corresponding to the new release (say, 0.5.0): </p>
<div class="fragment"><pre class="fragment">
cd ~/dev/sim/airracgit
git checkout trunk
git checkout -b 0.5.0
</pre></div><p> Update the version in the various build system files, replacing 99.99.99 by the correct version number: </p>
<div class="fragment"><pre class="fragment">
vi CMakeLists.txt
vi autogen.sh
</pre></div><p>Update the version and add a change-log in the ChangeLog and in the RPM specification files: </p>
<div class="fragment"><pre class="fragment">
vi ChangeLog
vi airrac.spec
</pre></div><h2><a class="anchor" id="branch_publish"></a>
Commit and publish the release branch</h2>
<p>Commit the new release: </p>
<div class="fragment"><pre class="fragment">
cd ~/dev/sim/airracgit
git add -A
git commit -m "[Release 0.5.0] Release of version 0.5.0."
git push
</pre></div><h2><a class="anchor" id="trunk_update"></a>
Update the change-log in the trunk as well</h2>
<p>Update the change-log in the ChangeLog and RPM specification files: </p>
<div class="fragment"><pre class="fragment">
cd ~/dev/sim/airracgit
git checkout trunk
vi ChangeLog
vi airrac.spec
</pre></div><p>Commit the change-logs and publish the trunk (main development branch): </p>
<div class="fragment"><pre class="fragment">
git commit -m "[Doc] Integrated the change-log of the release 0.5.0."
git push
</pre></div><h2><a class="anchor" id="create_packages"></a>
Create distribution packages</h2>
<p>Create the distribution packages using the following command:<br/>
</p>
<div class="fragment"><pre class="fragment">
cd ~/dev/sim/airracgit
git checkout 0.5.0
rm -rf build && mkdir -p build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/home/user/dev/deliveries/airrac-0.5.0 \
-DCMAKE_BUILD_TYPE:STRING=Debug -DINSTALL_DOC:BOOL=ON ..
make check && make dist
</pre></div><p>This will configure, compile and check the package. The output packages will be named, for instance, <code>airrac-0.5.0.tar.gz</code> and <code>airrac-0.5.0.tar.bz2</code>.</p>
<h2><a class="anchor" id="generate_rpm_packages"></a>
Generation the RPM packages</h2>
<p>Optionally, generate the RPM package (for instance, for <a href="http://fedoraproject.org">Fedora</a>/<a href="http://www.redhat.com">RedHat</a>): </p>
<div class="fragment"><pre class="fragment">
cd ~/dev/sim/airracgit
git checkout 0.5.0
rm -rf build && mkdir -p build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/home/user/dev/deliveries/airrac-0.5.0 \
-DCMAKE_BUILD_TYPE:STRING=Debug -DINSTALL_DOC:BOOL=ON ..
make dist
</pre></div><p>To perform this step, rpm-build, rpmlint and rpmdevtools have to be available on the system. </p>
<div class="fragment"><pre class="fragment">
cp airrac.spec ~/dev/packages/SPECS \
&& cp airrac-0.5.0.tar.bz2 ~/dev/packages/SOURCES
cd ~/dev/packages/SPECS
rpmbuild -ba airrac.spec
rpmlint -i ../SPECS/airrac.spec ../SRPMS/airrac-0.5.0-1.fc15.src.rpm \
../RPMS/noarch/airrac-* ../RPMS/i686/airrac-*
</pre></div><h2><a class="anchor" id="update_changelog"></a>
Update distributed change log</h2>
<p>Update the <code>NEWS</code> and <code>ChangeLog</code> files with appropriate information, including what has changed since the previous release. Then commit and push the changes into the <a href="http://airrac.git.sourceforge.net/git/gitweb.cgi?p=airrac/airrac;a=summary">AirRAC's Git repository</a>.</p>
<h2><a class="anchor" id="create_bin_packages"></a>
Create the binary package, including the documentation</h2>
<p>Create the binary package, which includes HTML and PDF documentation, using the following command: </p>
<div class="fragment"><pre class="fragment">
make package
</pre></div><p>The output binary package will be named, for instance, <code>airrac-0.5.0-Linux.tar.bz2</code>. That package contains both the HTML and PDF documentation. The binary package contains also the executables and shared libraries, as well as C++ header files, but all of those do not interest us for now.</p>
<h2><a class="anchor" id="upload_files"></a>
Upload the files to SourceForge</h2>
<p>Upload the distribution and documentation packages to the SourceForge server. Check <a href="https://sourceforge.net/apps/trac/sourceforge/wiki/Release%20files%20for%20download#SCP">SourceForge help page on uploading software</a>.</p>
<h2><a class="anchor" id="upload_doc"></a>
Upload the documentation to SourceForge</h2>
<p>In order to update the Web site files, either:</p>
<ul>
<li><a href="https://sourceforge.net/apps/trac/sourceforge/wiki/Shell%20service#Accessingyourfileswithothertools">synchronise them with rsync and SSH</a>: <div class="fragment"><pre class="fragment">
cd ~/dev/sim/airracgit
git checkout 0.5.0
rsync -aiv doc/html/ doc/latex/refman.pdf joe,airrac@web.sourceforge.net:htdocs/
</pre></div> where <code>-aiv</code> options mean:<ul>
<li><code>-a</code>: archive/mirror mode; equals <code>-rlptgoD</code> (no <code>-H</code>, <code>-A</code>, <code>-X</code>)</li>
<li><code>-v</code>: increase verbosity</li>
<li><code>-i</code>: output a change-summary for all updates</li>
<li>Note the trailing slashes (/) at the end of both the source and target directories. It means that the content of the source directory (<code>doc/html</code>), rather than the directory itself, has to be copied into the content of the target directory.</li>
</ul>
</li>
<li>or use the <a href="https://sourceforge.net/apps/trac/sourceforge/wiki/Shell%20service">SourceForge Shell service</a>.</li>
</ul>
<h2><a class="anchor" id="post_news"></a>
Make a new post</h2>
<ul>
<li>submit a new entry in the <a href="https://sourceforge.net/news/submit.php?group_id=317250">SourceForge project-related news feed</a></li>
<li>make a new post on the <a href="https://sourceforge.net/apps/wordpress/airrac/wp-admin/">SourceForge hosted WordPress blog</a></li>
<li>and update, if necessary, <a href="https://sourceforge.net/apps/trac/airrac/report">Trac tickets</a>.</li>
</ul>
<h2><a class="anchor" id="send_announce"></a>
Send an email on the announcement mailing-list</h2>
<p>Finally, you should send an announcement to <a href="mailto:airrac-announce@lists.sourceforge.net">airrac-announce@lists.sourceforge.net</a> (see <a href="https://lists.sourceforge.net/lists/listinfo/airrac-announce">https://lists.sourceforge.net/lists/listinfo/airrac-announce</a> for the archives) </p>
</div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<li class="footer">Generated on Wed Nov 2 2011 23:02:19 for AirRAC by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a>
1.7.4
</li>
<li class="footer">
<a href="http://sourceforge.net/projects/airrac"><img class="footer" src="http://sflogo.sourceforge.net/sflogo.php?group_id=317250&type=12&format=.png" alt="SourceForge Logo"></a>
</li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
12d0f975c6c7fa7093d99077a80c5759
>
files
>
185
