You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2010/11/06 14:03:26 UTC
svn commit: r1032033 - in /uima/site/trunk/uima-website:
docs/one-time-release-setup.html docs/staging/release.html
xdocs/one-time-release-setup.xml xdocs/staging/release.xml
Author: schor
Date: Sat Nov 6 13:03:26 2010
New Revision: 1032033
URL: http://svn.apache.org/viewvc?rev=1032033&view=rev
Log:
[UIMA-1929] tweak instructions on generating jira reports, plus minor clarification to one-time-release-setup
Modified:
uima/site/trunk/uima-website/docs/one-time-release-setup.html
uima/site/trunk/uima-website/docs/staging/release.html
uima/site/trunk/uima-website/xdocs/one-time-release-setup.xml
uima/site/trunk/uima-website/xdocs/staging/release.xml
Modified: uima/site/trunk/uima-website/docs/one-time-release-setup.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/one-time-release-setup.html?rev=1032033&r1=1032032&r2=1032033&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/one-time-release-setup.html (original)
+++ uima/site/trunk/uima-website/docs/one-time-release-setup.html Sat Nov 6 13:03:26 2010
@@ -189,7 +189,8 @@
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. It should have lines
+ <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>
<gpg.useagent>true</gpg.useagent>
Modified: uima/site/trunk/uima-website/docs/staging/release.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/staging/release.html?rev=1032033&r1=1032032&r2=1032033&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/staging/release.html (original)
+++ uima/site/trunk/uima-website/docs/staging/release.html Sat Nov 6 13:03:26 2010
@@ -319,10 +319,10 @@
and release numbers.
</li>
<li>
- Update both versions (text and HTML) of the release notes for the release.
- JIRA can provide a list of
+ Update the release notes for the release.
+ <!-- JIRA can provide a list of
issues for a certain release when using the 'ReleaseNotes' function,
- after you've closed the Jira issues to be released with this version.
+ after you've closed the Jira issues to be released with this version. -->
</li>
<li>Edit the POM of the top level thing being released, to add the property:
<pre><jiraVersion>123456</jiraVersion></pre>
@@ -344,20 +344,21 @@
<p>Each time this plugin is run, it creates an updated report in the
top level of this project. This report doesn't need to be checked into SVN.
- It will be copied into the distribution archives (source and binary)
- for this release. The RELEASE_NOTES.html files have been updated to
+ It will be regenerated and copied into the distribution archives (source and binary)
+ during a release. The RELEASE_NOTES.html files have been updated to
refer to this generated report.</p>
<p>Running the mvn release... command will cause this report to be generated or
updated, every time the command is run. So it is important that the POM
is updated to include the internal Jira version number, so the
right report is generated.</p>
- <p>If you know the report is already generated, and want to skip the part of the
- release which generates it, include -Dmaven.jiraReport.skip in your commandline.</p>
</li>
<li>
Do a trial build of the release candidate:
<pre>cd **directory for creating the distribution** e.g. uimaj-distr
-mvn install</pre>
+mvn install -Papache-release</pre>
+ <p>The <code>-Papache-release</code> can be used to have the build mimic the
+ build actions that would be taken when the release plugin is running
+ the release build.</p>
</li>
</ul>
</p>
@@ -462,9 +463,11 @@ mvn install</pre>
<blockquote class="subsectionBody">
<p>
POMs can refer to other artifacts in several ways, for example via the <parent-pom>
- element, or via a <dependency> element. References in these two elements are automatically updated
+ element, or via a <dependency> element. Often, a release will involve releasing together
+ multiple modules (all at -SNAPSHOT levels) that refer to one another using these elements.
+ When that happens, the references in these two elements are automatically updated
during the release process, from xx-SNAPSHOT to xx for the tag, and then to the next development level,
- for the trunk. So, no manual maintenance of these is needed; let the release plugin do this work.
+ for the trunk.
</p>
</blockquote>
</td></tr>
Modified: uima/site/trunk/uima-website/xdocs/one-time-release-setup.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/one-time-release-setup.xml?rev=1032033&r1=1032032&r2=1032033&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/one-time-release-setup.xml (original)
+++ uima/site/trunk/uima-website/xdocs/one-time-release-setup.xml Sat Nov 6 13:03:26 2010
@@ -51,7 +51,8 @@ under the License.
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. It should have lines
+ <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>
<gpg.useagent>true</gpg.useagent>
Modified: uima/site/trunk/uima-website/xdocs/staging/release.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/staging/release.xml?rev=1032033&r1=1032032&r2=1032033&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/staging/release.xml (original)
+++ uima/site/trunk/uima-website/xdocs/staging/release.xml Sat Nov 6 13:03:26 2010
@@ -138,10 +138,10 @@ under the License.
and release numbers.
</li>
<li>
- Update both versions (text and HTML) of the release notes for the release.
- JIRA can provide a list of
+ Update the release notes for the release.
+ <!-- JIRA can provide a list of
issues for a certain release when using the 'ReleaseNotes' function,
- after you've closed the Jira issues to be released with this version.
+ after you've closed the Jira issues to be released with this version. -->
</li>
<li>Edit the POM of the top level thing being released, to add the property:
<pre><jiraVersion>123456</jiraVersion></pre>
@@ -163,20 +163,21 @@ under the License.
<p>Each time this plugin is run, it creates an updated report in the
top level of this project. This report doesn't need to be checked into SVN.
- It will be copied into the distribution archives (source and binary)
- for this release. The RELEASE_NOTES.html files have been updated to
+ It will be regenerated and copied into the distribution archives (source and binary)
+ during a release. The RELEASE_NOTES.html files have been updated to
refer to this generated report.</p>
<p>Running the mvn release... command will cause this report to be generated or
updated, every time the command is run. So it is important that the POM
is updated to include the internal Jira version number, so the
right report is generated.</p>
- <p>If you know the report is already generated, and want to skip the part of the
- release which generates it, include -Dmaven.jiraReport.skip in your commandline.</p>
</li>
<li>
Do a trial build of the release candidate:
<pre>cd **directory for creating the distribution** e.g. uimaj-distr
-mvn install</pre>
+mvn install -Papache-release</pre>
+ <p>The <code>-Papache-release</code> can be used to have the build mimic the
+ build actions that would be taken when the release plugin is running
+ the release build.</p>
</li>
</ul>
</p>
@@ -252,9 +253,11 @@ mvn install</pre>
<subsection name='Removing -SNAPSHOT dependencies'>
<p>
POMs can refer to other artifacts in several ways, for example via the <parent-pom>
- element, or via a <dependency> element. References in these two elements are automatically updated
+ element, or via a <dependency> element. Often, a release will involve releasing together
+ multiple modules (all at -SNAPSHOT levels) that refer to one another using these elements.
+ When that happens, the references in these two elements are automatically updated
during the release process, from xx-SNAPSHOT to xx for the tag, and then to the next development level,
- for the trunk. So, no manual maintenance of these is needed; let the release plugin do this work.
+ for the trunk.
</p>
</subsection>