blob: 26a9279ad93cd14b592c8d6bcfdee20d437c9cfb [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.9.2 at 18 Sep 2022
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20220918" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache jUDDI &#x2013; Commiter Notes</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script>
</head>
<body class="topBarEnabled">
<a href="https://github.com/apache/juddi">
<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"
alt="Fork me on GitHub">
</a>
<div id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<div class="container-fluid">
<a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<ul class="nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache jUDDI <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="index.html" title="Welcome">Welcome</a></li>
<li class="dropdown-submenu">
<a href="demos.html" title="Live Demos">Live Demos</a>
<ul class="dropdown-menu">
<li><a href="https://demo.apache.juddi.org/" title="Sandbox">Sandbox</a></li>
</ul>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Downloads <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="releases.html" title="Releases">Releases</a></li>
<li><a href="source-repository.html" title="Source Code">Source Code</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="uddi.html" title="Supported UDDI Interfaces">Supported UDDI Interfaces</a></li>
<li><a href="security.html" title="Security Advisories">Security Advisories</a></li>
<li><a href="docs.html" title="jUDDI Docs">jUDDI Docs</a></li>
<li><a href="http://wiki.apache.org/juddi" title="Wiki">Wiki</a></li>
<li><a href="library.html" title="UDDI Library">UDDI Library</a></li>
<li><a href="apidocs2/index.html" title="Javadocs v2">Javadocs v2</a></li>
<li><a href="apidocs/index.html" title="Javadocs v3">Javadocs v3</a></li>
<li><a href="xref/index.html" title="XRef v3">XRef v3</a></li>
<li><a href="http://apachejuddi.blogspot.com/" title="jUDDI Blog">jUDDI Blog</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Subprojects <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="scout/" title="Apache Scout">Apache Scout</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Misc <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="participation.html" title="Participation">Participation</a></li>
<li><a href="who.html" title="Who We Are">Who We Are</a></li>
<li><a href="committers.html" title="Committer Notes">Committer Notes</a></li>
<li><a href="thanks.html" title="Sponsors">Sponsors</a></li>
<li><a href="legal.html" title="Legal">Legal</a></li>
<li><a href="license.html" title="License">License</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Modules <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="uddi-ws/index.html" title="UDDIv2 and v3 WS Stubs and Schema Bindings Generated from WSDL">UDDIv2 and v3 WS Stubs and Schema Bindings Generated from WSDL</a></li>
<li><a href="uddi-tck-base/index.html" title="UDDI Technical Compatibility Kit (TCK) Base">UDDI Technical Compatibility Kit (TCK) Base</a></li>
<li><a href="juddi-client/index.html" title="jUDDI Client side Code">jUDDI Client side Code</a></li>
<li><a href="juddi-client-cli/index.html" title="jUDDI CLI Client">jUDDI CLI Client</a></li>
<li><a href="uddi-migration-tool/index.html" title="UDDI Migration tool">UDDI Migration tool</a></li>
<li><a href="juddi-core/index.html" title="jUDDI Core Services">jUDDI Core Services</a></li>
<li><a href="juddi-rest-cxf/index.html" title="jUDDI REST Services using Apache CXF">jUDDI REST Services using Apache CXF</a></li>
<li><a href="juddi-core-openjpa/index.html" title="jUDDI Core - OpenJPA">jUDDI Core - OpenJPA</a></li>
<li><a href="juddiv3-war/index.html" title="jUDDI Services WAR">jUDDI Services WAR</a></li>
<li><a href="juddiv3-war-repl/index.html" title="jUDDI Replication Services WAR">jUDDI Replication Services WAR</a></li>
<li><a href="juddi-examples/index.html" title="jUDDI Examples">jUDDI Examples</a></li>
<li><a href="juddi-gui-war/index.html" title="jUDDI GUI WAR">jUDDI GUI WAR</a></li>
<li><a href="juddi-tomcat/index.html" title="jUDDI Tomcat Packaging">jUDDI Tomcat Packaging</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="dropdown-submenu">
<a href="project-info.html" title="Project Information">Project Information</a>
<ul class="dropdown-menu">
<li><a href="integration.html" title="CI Management">CI Management</a></li>
<li><a href="dependencies.html" title="Dependencies">Dependencies</a></li>
<li><a href="dependency-convergence.html" title="Dependency Convergence">Dependency Convergence</a></li>
<li><a href="dependency-info.html" title="Dependency Information">Dependency Information</a></li>
<li><a href="dependency-management.html" title="Dependency Management">Dependency Management</a></li>
<li><a href="distribution-management.html" title="Distribution Management">Distribution Management</a></li>
<li><a href="index.html" title="About">About</a></li>
<li><a href="issue-tracking.html" title="Issue Management">Issue Management</a></li>
<li><a href="license.html" title="Licenses">Licenses</a></li>
<li><a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a></li>
<li><a href="modules.html" title="Project Modules">Project Modules</a></li>
<li><a href="plugin-management.html" title="Plugin Management">Plugin Management</a></li>
<li><a href="plugins.html" title="Plugins">Plugins</a></li>
<li><a href="team-list.html" title="Team">Team</a></li>
<li><a href="source-repository.html" title="Source Code Management">Source Code Management</a></li>
<li><a href="project-summary.html" title="Summary">Summary</a></li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="project-reports.html" title="Project Reports">Project Reports</a>
<ul class="dropdown-menu">
<li><a href="apidocs/index.html" title="Javadoc">Javadoc</a></li>
<li><a href="testapidocs/index.html" title="Test Javadoc">Test Javadoc</a></li>
<li><a href="jdepend-report.html" title="JDepend">JDepend</a></li>
<li><a href="xref/index.html" title="Source Xref">Source Xref</a></li>
<li><a href="xref-test/index.html" title="Test Source Xref">Test Source Xref</a></li>
<li><a href="jira-report.html" title="JIRA Report">JIRA Report</a></li>
<li><a href="jacoco.html" title="Code Test Coverage">Code Test Coverage</a></li>
<li><a href="findbugs-aggregate.html" title="Findbugs Warnings">Findbugs Warnings</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container-fluid">
<div id="banner">
<div class="pull-left"><a href="./" id="bannerLeft"><img src="images/logo.png" alt="Apache jUDDI"/></a></div>
<div class="pull-right"><div id="bannerRight"><img src="images/apache_feather.gif" /></div>
</div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li class=""><a href="http://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
<li class="active ">Commiter Notes</li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 18 Sep 2022</li>
<li id="projectVersion" class="pull-right">Version: 3.3.11-SNAPSHOT</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Apache jUDDI</li>
<li><a href="index.html" title="Welcome"><span class="none"></span>Welcome</a> </li>
<li><a href="demos.html" title="Live Demos"><span class="icon-chevron-down"></span>Live Demos</a>
<ul class="nav nav-list">
<li><a href="https://demo.apache.juddi.org/" class="externalLink" title="Sandbox"><span class="none"></span>Sandbox</a> </li>
</ul>
</li>
<li class="nav-header">Downloads</li>
<li><a href="releases.html" title="Releases"><span class="none"></span>Releases</a> </li>
<li><a href="source-repository.html" title="Source Code"><span class="none"></span>Source Code</a> </li>
<li class="nav-header">Documentation</li>
<li><a href="uddi.html" title="Supported UDDI Interfaces"><span class="none"></span>Supported UDDI Interfaces</a> </li>
<li><a href="security.html" title="Security Advisories"><span class="none"></span>Security Advisories</a> </li>
<li><a href="docs.html" title="jUDDI Docs"><span class="none"></span>jUDDI Docs</a> </li>
<li><a href="http://wiki.apache.org/juddi" class="externalLink" title="Wiki"><span class="none"></span>Wiki</a> </li>
<li><a href="library.html" title="UDDI Library"><span class="none"></span>UDDI Library</a> </li>
<li><a href="apidocs2/index.html" title="Javadocs v2"><span class="none"></span>Javadocs v2</a> </li>
<li><a href="apidocs/index.html" title="Javadocs v3"><span class="none"></span>Javadocs v3</a> </li>
<li><a href="xref/index.html" title="XRef v3"><span class="none"></span>XRef v3</a> </li>
<li><a href="http://apachejuddi.blogspot.com/" class="externalLink" title="jUDDI Blog"><span class="none"></span>jUDDI Blog</a> </li>
<li class="nav-header">Subprojects</li>
<li><a href="scout/" title="Apache Scout"><span class="none"></span>Apache Scout</a> </li>
<li class="nav-header">Misc</li>
<li><a href="participation.html" title="Participation"><span class="none"></span>Participation</a> </li>
<li><a href="who.html" title="Who We Are"><span class="none"></span>Who We Are</a> </li>
<li class="active"><a href="#"><span class="none"></span>Committer Notes</a>
</li>
<li><a href="thanks.html" title="Sponsors"><span class="none"></span>Sponsors</a> </li>
<li><a href="legal.html" title="Legal"><span class="none"></span>Legal</a> </li>
<li><a href="license.html" title="License"><span class="none"></span>License</a> </li>
<li class="nav-header">Modules</li>
<li><a href="uddi-ws/index.html" title="UDDIv2 and v3 WS Stubs and Schema Bindings Generated from WSDL"><span class="none"></span>UDDIv2 and v3 WS Stubs and Schema Bindings Generated from WSDL</a> </li>
<li><a href="uddi-tck-base/index.html" title="UDDI Technical Compatibility Kit (TCK) Base"><span class="none"></span>UDDI Technical Compatibility Kit (TCK) Base</a> </li>
<li><a href="juddi-client/index.html" title="jUDDI Client side Code"><span class="none"></span>jUDDI Client side Code</a> </li>
<li><a href="juddi-client-cli/index.html" title="jUDDI CLI Client"><span class="none"></span>jUDDI CLI Client</a> </li>
<li><a href="uddi-migration-tool/index.html" title="UDDI Migration tool"><span class="none"></span>UDDI Migration tool</a> </li>
<li><a href="juddi-core/index.html" title="jUDDI Core Services"><span class="none"></span>jUDDI Core Services</a> </li>
<li><a href="juddi-rest-cxf/index.html" title="jUDDI REST Services using Apache CXF"><span class="none"></span>jUDDI REST Services using Apache CXF</a> </li>
<li><a href="juddi-core-openjpa/index.html" title="jUDDI Core - OpenJPA"><span class="none"></span>jUDDI Core - OpenJPA</a> </li>
<li><a href="juddiv3-war/index.html" title="jUDDI Services WAR"><span class="none"></span>jUDDI Services WAR</a> </li>
<li><a href="juddiv3-war-repl/index.html" title="jUDDI Replication Services WAR"><span class="none"></span>jUDDI Replication Services WAR</a> </li>
<li><a href="juddi-examples/index.html" title="jUDDI Examples"><span class="none"></span>jUDDI Examples</a> </li>
<li><a href="juddi-gui-war/index.html" title="jUDDI GUI WAR"><span class="none"></span>jUDDI GUI WAR</a> </li>
<li><a href="juddi-tomcat/index.html" title="jUDDI Tomcat Packaging"><span class="none"></span>jUDDI Tomcat Packaging</a> </li>
<li class="nav-header">Project Documentation</li>
<li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a> </li>
<li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a> </li>
</ul>
<form id="search-form" action="https://www.google.com/search" method="get" >
<input value="$sitesearchValue" name="sitesearch" type="hidden"/>
<input class="search-query" name="q" id="query" type="text" />
</form>
<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script>
<hr />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
</div>
</div>
</div>
<div id="bodyColumn" class="span10" >
<section>
<h2><a name="Updating_the_jUDDI_Web_Site"></a>Updating the jUDDI Web Site</h2>
<p>The site source is located under our source tree at <a class="externalLink" href="http://svn.apache.org/repos/asf/juddi/cms-site/">juddi/src/cms-site</a>.</p>
<p>There are two ways to edit the content for this site.</p>
<ol style="list-style-type: decimal">
<li>Edit the files in the Subversion repository</li>
<li>Using <a class="externalLink" href="https://cms.apache.org/#bookmark">Apache&#x2019;s CMS Bookmarklet</a></li>
<li>Simply <a class="externalLink" href="https://cms.apache.org/redirect?uri=http://juddi.apache.org/">Click here</a></li>
</ol>
<p>Once you&#x2019;re done making edits, commit the changes. Changes can be previewed on the <a class="externalLink" href="http://juddi.staging.apache.org/">staging site</a>. If you&#x2019;re satisfied with the results, then publish it to the production site.</p>
<p>Still have questions? Check out <a class="externalLink" href="http://www.apache.org/dev/cms.html">this</a>, <a class="externalLink" href="http://www.apache.org/dev/cmsref.html">this</a> and <a class="externalLink" href="http://michelf.ca/projects/php-markdown/extra/">this</a>.</p>
<p>When updating javadoc or xref sections, it&#x2019;s easier to just use svn and commit it that way</p><section>
<h3><a name="Notes"></a>Notes</h3>
<ul>
<li>Each page has a &#x2018;Title&#x2019; header except for the home page.</li>
<li>Content is annotated using <a class="externalLink" href="http://daringfireball.net/projects/markdown/syntax">Markdown</a></li>
<li>All pages, except for the home page, using this <a class="externalLink" href="http://svn.apache.org/repos/asf/juddi/cms-site/trunk/templates/skeleton.html">template</a></li>
<li>The home page, uses this <a class="externalLink" href="http://svn.apache.org/repos/asf/juddi/cms-site/trunk/templates/skeletonHome.html">template</a></li>
<li>When updating the navigation bars (top or left hand side), edit both templates</li>
</ul></section></section><section>
<h2><a name="Release_Process"></a>Release Process</h2><section>
<h3><a name="Release_Manager"></a>Release Manager</h3>
<p>One committer will be elected or hopefully volunteer to assemble the binary releases and label the source tree.</p></section><section>
<h3><a name="Digitally_Signing_Releases"></a>Digitally Signing Releases</h3>
<p>Apache policy requires binary releases be digitaly signed. The Apache process has not been formalized, but a general discussion about creating digital signatures and signing releases is available at <a class="externalLink" href="http://nagoya.apache.org/wiki/apachewiki.cgi?SigningReleases">http://nagoya.apache.org/wiki/apachewiki.cgi?SigningReleases</a>. This covers some basics about using GnuPG to create key pairs and sign releases. Our goal here is to discuss jUDDI signing requirements, and provide some useful examples to release managers, not discuss digital signatures or encryption technology. Our discussion uses GnuPG, but any compliant software could be used. The examples below come from the GnuPG manual. This discussion is not a subsitute for reading that manual.</p>
<p>Creating a key pair is pretty simple using gpg. Simply invoke gpg and take all the defaults when prompted. You will have to provide a passphrase. Be sure to remember the passphrase since you&#x2019;ll need it anytime you use the key pair. The passphrase should itself be sufficiently secure; it shouldn&#x2019;t simply be a word in a dictionary, should include a mix of digits and alphanumeric characters, etc.</p>
<div class="source">
<div class="source"><pre class="prettyprint linenums">gpg --gen-key
</pre></div></div>
<p>You should also generate a revocation certificate. This allows you to declare the key pair invalid publicly, if you ever lose your private key, or it becomes compromised.</p>
<div class="source">
<div class="source"><pre class="prettyprint linenums">gpg --output revoke.as --gen-revoke mykey
</pre></div></div>
<p>The release manager is responsible for signing the binaries. The release manager must have a public key listed in the &#x2018;KEYS&#x2019; file at the root of our source tree. The release manager must create a detached signature for each binary. This detached signature must be posted along with our binaries, and allow our users to verify the binary&#x2019;s integrity.</p>
<div class="source">
<div class="source"><pre class="prettyprint linenums">gpg --output jUDDI.tar.gzip.asc --detach-sig jUDDI.tar.gzip
</pre></div></div>
<p>All jUDDI committers are encouraged to create public/ private key pairs and place the public half into our &#x2018;KEYS&#x2019; file at the root of our source tree. jUDDI committers are also encouraged to verify one another&#x2019;s keys and sign them, to help create a web of trust. Verifying a signature and a binary guarantees (in any real sense) the binary was assembled by the person that signed it. However, it does not prove the person signing it can be trusted. A web of trust can be created by signing one another&#x2019;s keys. This allows users and developers to &#x2018;trust&#x2019; the person who created the document-signature pair to provide a secure, safe binary.</p></section><section>
<h3><a name="Release_Procedure"></a>Release Procedure</h3>
<p><b>TIP:</b> produce the release artifacts with JRE/JDK7</p>
<ol style="list-style-type: decimal">
<li>Ensure the build works (mvn clean install -Pdist)</li>
<li>Grab the current version&#x2019;s release notes using JIRA. Goto JIRA, Versions, pick the version, then Release notes. Replace the release notes html file within the source with the contents from JIRA.</li>
<li>mvn release:prepare -Papache-release</li>
<li>mvn release:perform -Papache-release</li>
<li>Sign in to <a class="externalLink" href="https://repository.apache.org/">Nexus</a> and close the staging repo.</li>
<li>Send a [VOTE] email to the dev mailing list regarding the new release.</li>
<li>Upon a successful vote, sign in to Nexus and release the staging repo</li>
<li>Add the release to svn <a class="externalLink" href="https://dist.apache.org/repos/dist/release/juddi/">https://dist.apache.org/repos/dist/release/juddi/</a></li>
<li>Update the website with updated links, update source code and user documentation</li>
<li>JIRA actions: close any tickets associated with the released version, then set the release date.</li>
<li>Promote</li>
</ol></section></section>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>Copyright &copy;2004&#x2013;2022
<a href="https://www.apache.org/">The Apache Software Foundation</a>.
All rights reserved.</p>
</div>
</div>
</footer>
</body>
</html>