blob: 73c686816fcb8e74736accc8f4001168fee67f5c [file]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "https://www.w3.org/TR/html4/loose.dtd">
<!-- ====================================================================== -->
<!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
<!-- ====================================================================== -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<style type="text/css">@import "stylesheets/base.css";</style>
<meta name="author" value="
Apache UIMA Documentation Team">
<meta name="email" value="dev@uima.apache.org">
<title>Apache UIMA - One time release setup</title>
<!-- Begin Cookie Consent plugin by Silktide - https://silktide.com/cookieconsent -->
<!-- Commented out because implied consent is not compatible with GDPR -->
<!--
<script type="text/javascript">
window.cookieconsent_options = {"message":"This website uses cookies to ensure you get the best experience on our website","dismiss":"Got it!","learnMore":"More info","link":"https://uima.apache.org/privacy-policy.html","theme":"dark-bottom"};
</script>
<script type="text/javascript" src="/cookieconsent2/cookieconsent.min.js"></script>
-->
<!-- End Cookie Consent plugin -->
<!-- Begin Google Analytics -->
<!-- Commented out because GA requires consent according to GDPR -->
<!--
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-70846351-1', 'auto');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
</script>
-->
<!-- End Google Analytics -->
</head>
<body>
<div class="topLogos">
<table border="0" width="100%" cellspacing="0">
<!-- TOP IMAGE -->
<tr>
<td align='LEFT'>
<a href="index.html">
<img style="border: 1px solid black;" src="./images/UIMA_banner2tlpTm.png" alt="UIMA project logo" border="0"/>
</a>
</td>
<td align='CENTER'>
<div class="pageBanner">One time release setup</div>
</td>
<td align='RIGHT'>
<a href="https://www.apache.org">
<img src="./images/asf-logo-on-white-smallTm.png" alt="Apache UIMA" border="0"/>
</a>
</td>
</tr>
</table>
<hr noshade="" size="1"/>
</div>
<table border="0" width="100%" cellspacing="4">
<tr>
<td align='RIGHT' colspan="2">
<form method="get" action="https://www.google.com/search">
Search the site
<input type="text" name="q" size="25" maxlength="255" value="" />
<input type="hidden" name="sitesearch" value="https://uima.apache.org/" />
<input name="Search" value="Search Site" type="submit"/>
</form>
</td>
</tr>
<tr> <!-- LEFT SIDE NAVIGATION -->
<td width="20%" valign="top">
<!-- regular menu -->
<div class="navBar">
<br/>
<div class="navBarItem"> <div class="navPartHeading">General</div>
</div>
<div class="navBar">
<div class="navBarItem"> <a href="./index.html">Home</a>
</div>
<div class="navBarItem"> <a href="./downloads.cgi">Downloads</a>
</div>
<div class="navBarItem"> <a href="./documentation.html">Documentation</a>
</div>
<div class="navBarItem"> <a href="./news.html">News</a>
</div>
<div class="navBarItem"> <a href="./publications.html">Publications</a>
</div>
<br style="line-height: .5em"/>
<div class="navBarItem"> <a href="https://issues.apache.org/jira/browse/uima" target="_blank" rel="noopener">Issue tracker <img src="images/offsitelink.png"/></a>
</div>
<div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/" target="_blank" rel="noopener">Wiki <img src="images/offsitelink.png"/></a>
</div>
<br style="line-height: .5em"/>
<div class="navBarItem"> <a href="https://cwiki.apache.org/confluence/display/UIMA/Powered+by+Apache+UIMA" target="_blank" rel="noopener">Powered By UIMA <img src="images/offsitelink.png"/></a>
</div>
</div>
<br/>
<div class="navBarItem"> <div class="navPartHeading">Community</div>
</div>
<div class="navBar">
<div class="navBarItem"> <a href="./get-involved.html">Get Involved</a>
</div>
<div class="navBarItem"> <a href="./mail-lists.html">Mailing Lists</a>
</div>
<div class="navBarItem"> <a href="./contribution-policy.html">Contribution Policies</a>
</div>
<div class="navBarItem"> <a href="./faq.html">FAQ</a>
</div>
<div class="navBarItem"> <a href="./project-guidelines.html">Project Guidelines</a>
</div>
</div>
<br/>
<div class="navBarItem"> <div class="navPartHeading">Components & Tools</div>
</div>
<div class="navBar">
<div class="navBarItem"> <a href="./sandbox.html#uima-addons-annotators">Annotators</a>
</div>
<div class="navBarItem"> <a href="./toolsServers.html">Tools & Servers</a>
</div>
<div class="navBarItem"> <a href="./sandbox.html">Addons and Sandbox</a>
</div>
<div class="navBarItem"> <a href="./ruta.html">UIMA Ruta</a>
</div>
<div class="navBarItem"> <a href="https://github.com/apache/uima-uimafit" target="_blank" rel="noopener">uimaFIT <img src="images/offsitelink.png"/></a>
</div>
<div class="navBarItem"> <a href="./external-resources.html">External Resources</a>
</div>
</div>
<br/>
<div class="navBarItem"> <div class="navPartHeading">Development</div>
</div>
<div class="navBar">
<div class="navBarItem"> <a href="./dev-quick.html">Quick Start: building</a>
</div>
<div class="navBarItem"> <a href="./building-uima.html">Building from Source</a>
</div>
<div class="navBarItem"> <a href="./one-time-setup.html">One-time setups</a>
</div>
<div class="navBarItem"> <a href="./svn.html">Source Code</a>
</div>
<div class="navBarItem"> <a href="./release.html">Doing a UIMA release</a>
</div>
<div class="navBarItem"> <a href="https://www.apache.org/security/committers.html" target="_blank" rel="noopener">Doing a CVE (Apache) <img src="images/offsitelink.png"/></a>
</div>
<div class="navBarItem"> <a href="./eclipse-update-site.html">Eclipse Update Sites</a>
</div>
<div class="navBarItem"> <a href="./git.html">GIT</a>
</div>
<div class="navBarItem"> <a href="./codeConventions.html">Code Conventions</a>
</div>
<div class="navBarItem"> <a href="./uima-specification.html">UIMA Specification (OASIS)</a>
</div>
<div class="navBarItem"> <a href="./team-list.html">Project Team</a>
</div>
<div class="navBarItem"> <a href="./maven-design.html">Maven Use</a>
</div>
<div class="navBarItem"> <a href="./updating-website.html">Updating this Website</a>
</div>
</div>
<br/>
<div class="navBarItem"> <div class="navPartHeading">Events and Conferences</div>
</div>
<div class="navBar">
<div class="navBarItem"> <a href="./coling14.html">COLING 2014</a>
</div>
<div class="navBarItem"> <a href="./gscl13.html">GSCL 2013</a>
</div>
<div class="navBarItem"> <a href="./iks09.html">IKS 2009</a>
</div>
<div class="navBarItem"> <a href="./gscl09.html">GSCL 2009</a>
</div>
<div class="navBarItem"> <a href="./lsm09.html">LSM 2009</a>
</div>
<div class="navBarItem"> <a href="./lrec08.html">LREC 2008</a>
</div>
<div class="navBarItem"> <a href="./gldv07.html">GLDV 2007</a>
</div>
</div>
<br/>
<div class="navBarItem"> <div class="navPartHeading">ASF</div>
</div>
<div class="navBar">
<div class="navBarItem"> <a href="https://www.apache.org/licenses/" target="_blank" rel="noopener">License <img src="images/offsitelink.png"/></a>
</div>
<div class="navBarItem"> <a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener">ASF Sponsors <img src="images/offsitelink.png"/></a>
</div>
<div class="navBarItem"> <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener">ASF Sponsorship <img src="images/offsitelink.png"/></a>
</div>
<div class="navBarItem"> <a href="./security_report">Security</a>
</div>
</div>
</div>
</td>
<td width="80%" align="left" valign="top">
<div class="sectionTable">
<table class="sectionTable">
<tr><td>
<a name="One time setup instructions for releasing Apache UIMA"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/>&nbsp;One time setup instructions for releasing Apache UIMA</h1></a>
</td></tr>
<tr><td>
<blockquote class="sectionBody">
<p>
Here you will find information on how to set up various tools
and configurations needed when releasing Apache UIMA&trade; artifacts.
</p>
<p>First, be sure you've done the general
<a href="one-time-setup.html">one-time-setup</a>.
</p>
<p>The rest of the setup is taken from various other sources around Apache
(links below).</p>
<ul>
<li>
<b><code>Settings.xml</code></b> file:
<p>Create and/or update your Maven settings.xml file (located where your local repo is).
Follow <a target="_blank" rel="noopener" href="https://maven.apache.org/developers/committer-settings.html">these instructions</a> (but
ignore the last line about needing to be a member of group <code>apcvs</code> and <code>maven</code>).
Use Maven's <a target="_blank" rel="noopener" href="https://maven.apache.org/guides/mini/guide-encryption.html">
password encryption capabilities</a> to encrypt your LDAP password, used to log on to
the server for uploading things to the Apache Nexus Repositories (both SNAPSHOTs and Staging).
</p>
<p>Your settings file should <b>not</b> contain your GPG passphrase, to avoid the security
risk inherent in having this in a file stored on your machine. Instead, it should have lines
like these:
<pre style="font-size:70%">
&lt;gpg.useagent&gt;true&lt;/gpg.useagent&gt;
&lt;!--gpg.passphrase&gt;&lt;/gpg.passphrase--&gt; &lt;!-- don't put passphrase in file --&gt;
</pre>
</p>
<p>These lines go in your settings.xml file, inside a &lt;profile&gt; that is active when the signing is needed
(you can just make it active always, too), inside a &lt;properties&gt; element, like so:
<pre style="font-size:70%">&lt;properties&gt;
&lt;gpg.useagent&gt;true&lt;/gpg.useagent&gt;
...
&lt;/properties&gt;</pre>
</p>
<p>Here is a sample settings.xml profile:
<pre style="font-size:70%">&lt;settings xmlns="https://maven.apache.org/POM/4.0.0"
xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://maven.apache.org/POM/4.0.0
https://maven.apache.org/xsd/settings-1.0.0.xsd"&gt;
&lt;profiles&gt;
&lt;profile&gt;
&lt;id&gt;local-build-configuration&lt;/id&gt;
&lt;!-- Use &lt;activeProfiles&gt;
&lt;activeProfile&gt;local-build-configuration&lt;/activeProfile&gt;
&lt;/activeProfiles&gt;
outside of the &lt;profile&gt; element. See example at bottom.
&lt;properties&gt;
&lt;uima-maven-build-eclipse-home&gt;C:/p/eclipse/3.5/eclipse&lt;/uima-maven-build-eclipse-home&gt;
&lt;uimaWebsiteDistributionUrl&gt;file:///c:/a/uimaWebsite/&lt;/uimaWebsiteDistributionUrl&gt;
&lt;gpg.useagent&gt;true&lt;/gpg.useagent&gt;
&lt;/properties&gt;
&lt;/profile&gt;
&lt;/profiles&gt;
&lt;!-- activeProfiles - a list of profiles that are active for all builds --&gt;
&lt;activeProfiles&gt;
&lt;activeProfile&gt;local-build-configuration&lt;/activeProfile&gt;
&lt;/activeProfiles&gt;
&lt;/settings&gt;</pre>
</p>
</li>
<li>
Create (if you haven't already) your GPG keys; see
<a target="_blank" rel="noopener" href="https://apache.org/dev/openpgp.html">Making GPG Keys</a>.
The UIMA project KEYS file is stored in SVN in the trunk/uima-website/docs/KEYS file.
Please add your exported public key to the bottom of this file, and commit the change.
<p>
Also, checkout and update the KEYS file at the top level of our release distribution, located
at https://dist.apache.org/repos/dist/release/uima/KEYS.
</p>
</li>
<li>You need to have a recent GPG client installed;
the recent ones support the capability to have a window pop up
when
the passphrase is needed - so you never need to put the passphrase into a file. And,
they remember this, so if you're signing a bunch of things, you only need to put in the
passphrase once (it forgets/resets after a few minutes).
I've found <a target="_blank" rel="noopener" href="https://www.gpg4win.org/">https://www.gpg4win.org/</a>
has this kind of support, for Windows XP.
See the main gpg site
<a target="_blank" rel="noopener" href="https://www.gnupg.org/">https://www.gnupg.org/</a> for references
to other implementations.
</li>
<li>
You need a current version of the SVN client, Subversion (1.6) installed and on your shell's path.
See <a target="_blank" rel="noopener" href="https://subversion.apache.org/">https://subversion.apache.org/</a>
At least one person has had success using the client from <a target="_blank" rel="noopener" href="https://www.collab.net/downloads/subversion/">Collabnet</a> on Windows.
</li>
<li>You need Java 1.5. (Our builds should be done with 1.5 to catch any accidental use of 1.6-only
methods).</li>
<li>Set the environmental variable <code>MAVEN_OPTS</code> to "-Xmx800m -XX:MaxPermSize=256m"
(these may be too large, but they currently work).</li>
<li>Download and install Maven 3.0-beta-1 (or later), and set it up to be on the PATH.</li>
</ul>
</blockquote>
</p>
</td></tr>
</table>
</td>
</tr>
<!-- FOOTER -->
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr><td colspan="2">
<table class="pageFooter">
<tr>
<td><a href="index.html">Home</a></td>
<td><a href="privacy-policy.html">Privacy Policy</a></td>
<td style="font-size:75%">
Copyright &#169; 2006-2024, The Apache Software Foundation.<br/>
Apache UIMA, UIMA, the Apache UIMA logo and the Apache Feather logo are trademarks of The Apache Software Foundation.<br/>
All other marks mentioned may be trademarks or registered trademarks of their respective owners.
</td>
<td><a href="mailto:dev@uima.apache.org">Contact us</a></td>
</tr>
</table>
</td></tr>
</table>
</body>
</html>