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 2018/10/12 21:48:33 UTC
svn commit: r1843714 - in /uima/site/trunk/uima-website:
docs/maven-design.html xdocs/maven-design.xml
Author: schor
Date: Fri Oct 12 21:48:32 2018
New Revision: 1843714
URL: http://svn.apache.org/viewvc?rev=1843714&view=rev
Log:
no jira, update the maven-design webpage to clarify how source-release is handled, for two different targets.
Modified:
uima/site/trunk/uima-website/docs/maven-design.html
uima/site/trunk/uima-website/xdocs/maven-design.xml
Modified: uima/site/trunk/uima-website/docs/maven-design.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/maven-design.html?rev=1843714&r1=1843713&r2=1843714&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/maven-design.html (original)
+++ uima/site/trunk/uima-website/docs/maven-design.html Fri Oct 12 21:48:32 2018
@@ -258,8 +258,8 @@ building the various parts of UIMA.</p>
POM style
</a></li>
- <li><a href='#Release artifacts'>
- Release artifacts
+ <li><a href='#Release artifacts, signing, checksums'>
+ Release artifacts, signing, checksums
</a></li>
<li><a href='#Handling Documentation'>
@@ -456,8 +456,8 @@ our svn tree, in a top level directory n
- <a name="Release artifacts">
- <h2>Release artifacts
+ <a name="Release artifacts, signing, checksums">
+ <h2>Release artifacts, signing, checksums
</h2>
</a>
</td></tr>
@@ -465,6 +465,14 @@ our svn tree, in a top level directory n
<blockquote class="subsectionBody">
<p>We follow the standard release process for Maven-based artifacts at Apache,
documented <a target="_blank" href="https://www.apache.org/dev/publishing-maven-artifacts.html">here.</a></p>
+ <p>There are two places artifacts go to:</p>
+ <ol>
+ <li>Apache's mirror distribution system</li>
+ <li>Maven "central" for maven-findable artifacts (typically JARs)</li>
+ </ol>
+ <p>Apache's mirror distribution system is used to distribute the source-release.zip and
+ any binary convenience packages.
+ </p>
<p>For each artifact, the release process may build additional artifacts, and
attach them to the main one, so they will "go along with" the main artifact during
Maven deployment to repositories. Some of these are:</p>
@@ -472,21 +480,19 @@ our svn tree, in a top level directory n
<li>
sources.jar - holds the source files - this is for IDEs that want to refer to the source
</li>
-
- <li><p>
- source-release.zip. This is the same as the sources, but includes all other files
+ <li>javadocs.jar</li>
+ </ul>
+ <p>The source-release.zip file is a special artifact, like the sources.jar, but includes all other files
(such as the pom.xml) not under the /src
directory, needed for building.
The intent is that this is the same as the SVN checked-in files, and once unzipped, this
should be "buildable" by doing "mvn install", etc. in the unzipped directory.
</p>
- <p><code>source-release.zip</code> files for multi-project aggregates (such as the main
- UIMA SDK) are not "attached", and are not uploaded to maven for distribution; instead,
- these are considered the main binary artifacts for the project and are distributed
- using Apache's own mirroring distribution system.
- </p>
- </li>
- </ul>
+ <p><code>source-release.zip</code> files for multi-project aggregates (such as the main
+ UIMA SDK) are built only at the top (root) level; the pom for that level typically specifies
+ to skip the deploy to maven-central, so the convenience packages and the source-release.zip are not deployed
+ there, but instead are distributed via Apache's mirror system.
+ </p>
<p>
The release process happens when the commands <code>mvn release:prepare</code> followed by
<code>mvn release:perform</code> are executed. The release plugin is set up by the common
@@ -496,6 +502,8 @@ our svn tree, in a top level directory n
You can debug this process without doing a release, by adding the parameter
<code>-Papache-release</code> to the non-release Maven build commands.
</p>
+ <p>All artifacts have gpg signatures, as well as .sha512 checksums. These are typically created during the build
+ process for the main artifact, all attached artifacts, and the pom.</p>
<h2>LICENSE and NOTICE files</h2>
<p>
Things that are distributed from Apache need LICENSE and NOTICE files. We have several kinds
Modified: uima/site/trunk/uima-website/xdocs/maven-design.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/maven-design.xml?rev=1843714&r1=1843713&r2=1843714&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/maven-design.xml (original)
+++ uima/site/trunk/uima-website/xdocs/maven-design.xml Fri Oct 12 21:48:32 2018
@@ -183,10 +183,21 @@ our svn tree, in a top level directory n
</subsection>
-<subsection name="Release artifacts">
+<subsection name="Release artifacts, signing, checksums">
<p>We follow the standard release process for Maven-based artifacts at Apache,
documented <a target="_blank"
href="https://www.apache.org/dev/publishing-maven-artifacts.html">here.</a></p>
+
+ <p>There are two places artifacts go to:</p>
+ <ol>
+ <li>Apache's mirror distribution system</li>
+ <li>Maven "central" for maven-findable artifacts (typically JARs)</li>
+ </ol>
+
+ <p>Apache's mirror distribution system is used to distribute the source-release.zip and
+ any binary convenience packages.
+ </p>
+
<p>For each artifact, the release process may build additional artifacts, and
attach them to the main one, so they will "go along with" the main artifact during
Maven deployment to repositories. Some of these are:</p>
@@ -194,21 +205,21 @@ our svn tree, in a top level directory n
<li>
sources.jar - holds the source files - this is for IDEs that want to refer to the source
</li>
-
- <li><p>
- source-release.zip. This is the same as the sources, but includes all other files
+ <li>javadocs.jar</li>
+ </ul>
+
+ <p>The source-release.zip file is a special artifact, like the sources.jar, but includes all other files
(such as the pom.xml) not under the /src
directory, needed for building.
The intent is that this is the same as the SVN checked-in files, and once unzipped, this
should be "buildable" by doing "mvn install", etc. in the unzipped directory.
</p>
<p><code>source-release.zip</code> files for multi-project aggregates (such as the main
- UIMA SDK) are not "attached", and are not uploaded to maven for distribution; instead,
- these are considered the main binary artifacts for the project and are distributed
- using Apache's own mirroring distribution system.
- </p>
- </li>
- </ul>
+ UIMA SDK) are built only at the top (root) level; the pom for that level typically specifies
+ to skip the deploy to maven-central, so the convenience packages and the source-release.zip are not deployed
+ there, but instead are distributed via Apache's mirror system.
+ </p>
+
<p>
The release process happens when the commands <code>mvn release:prepare</code> followed by
<code>mvn release:perform</code> are executed. The release plugin is set up by the common
@@ -219,6 +230,9 @@ our svn tree, in a top level directory n
<code>-Papache-release</code> to the non-release Maven build commands.
</p>
+ <p>All artifacts have gpg signatures, as well as .sha512 checksums. These are typically created during the build
+ process for the main artifact, all attached artifacts, and the pom.</p>
+
<h2>LICENSE and NOTICE files</h2>
<p>
Things that are distributed from Apache need LICENSE and NOTICE files. We have several kinds