Jump to: navigation, search

Difference between revisions of "Jetty/Contributor/Releasing"

Line 1: Line 1:
The Jetty project uses Apache Maven to build and release its software artifacts.  This terminology is oft confused with the release process of projects within eclipse so we are endeavoring to bridge these differences.  We are still working out the process for releasing jetty in the eclipse definition of the work and will be documented once we are there.
+
{{Jetty Contributors}}
 +
 
 +
The Jetty project uses Apache Maven to build and release its software artifacts.  This terminology is oft confused with the release process of projects within Eclipse so we are endeavoring to bridge these differences.  We are still working out the process for releasing Jetty in the Eclipse definition of the word; this will be documented once we are there.
  
 
== Maven Related Instructions ==
 
== Maven Related Instructions ==
Line 5: Line 7:
 
== Releasing Artifacts ==
 
== Releasing Artifacts ==
  
> <tt>mvn -Dusername=<committer id> -DautoVersionSubmodules=true release:prepare</tt>
+
mvn -Dusername=<committer id> -DautoVersionSubmodules=true release:prepare
 
+
mvn release:perform
> <tt>mvn release:perform</tt>
+
  
 
The released artifacts will be staged to oss.sonatype.org where they await promotion when they will be released to the maven central repository.  More on this later.
 
The released artifacts will be staged to oss.sonatype.org where they await promotion when they will be released to the maven central repository.  More on this later.
Line 18: Line 19:
 
To build and deploy the aggregate javadoc and jxr bits:
 
To build and deploy the aggregate javadoc and jxr bits:
  
> <tt>mvn -Paggregate-site javadoc:aggregate jxr:jxr</tt>
+
mvn -Paggregate-site javadoc:aggregate jxr:jxr
 
+
mvn -N site:deploy
> <tt>mvn -N site:deploy</tt>
+
  
 
This will generate the aggregate docs and deploy them to the ''/home/www/jetty/<project version>/jetty-project'' directory on ''download.eclipse.org''.  The last step is to ssh to that machine and adjust the placement of the apidocs and xref directories to remove the jetty-project folder from the url so that we maintain a clean and consistent api url scheme.
 
This will generate the aggregate docs and deploy them to the ''/home/www/jetty/<project version>/jetty-project'' directory on ''download.eclipse.org''.  The last step is to ssh to that machine and adjust the placement of the apidocs and xref directories to remove the jetty-project folder from the url so that we maintain a clean and consistent api url scheme.

Revision as of 05:52, 23 June 2009


The Jetty project uses Apache Maven to build and release its software artifacts. This terminology is oft confused with the release process of projects within Eclipse so we are endeavoring to bridge these differences. We are still working out the process for releasing Jetty in the Eclipse definition of the word; this will be documented once we are there.

Maven Related Instructions

Releasing Artifacts

mvn -Dusername=<committer id> -DautoVersionSubmodules=true release:prepare
mvn release:perform

The released artifacts will be staged to oss.sonatype.org where they await promotion when they will be released to the maven central repository. More on this later.


Building and Deploying Aggregate Docs

Define the jetty.eclipse.website server entry in your .m2/settings.xml file. You'll need to have access to the dev.eclipse.org machine to perform these actions. If you don't know if you have access to this then you probably don't and will need to ask a project leader for help.

To build and deploy the aggregate javadoc and jxr bits:

mvn -Paggregate-site javadoc:aggregate jxr:jxr
mvn -N site:deploy

This will generate the aggregate docs and deploy them to the /home/www/jetty/<project version>/jetty-project directory on download.eclipse.org. The last step is to ssh to that machine and adjust the placement of the apidocs and xref directories to remove the jetty-project folder from the url so that we maintain a clean and consistent api url scheme.

End result should be api documents accessible from http://download.eclipse.org/jetty/<project version>/api-docs and http://download.eclipse.org/jetty/<project version>/xref

Adding a Link to the Index on the Wiki

Update Jetty/Reference; add a link to the top of the Jetty/Reference#Previous Stable Releases Reference section.

Deploying distribution files to download.eclipse.org

  • download the files in http://repo2.maven.org/maven2/org/eclipse/jetty/jetty-distribution/VERSION into a directory called 'dist'
  • scp -r dist <user>@dev.eclipse.org:/home/www/jetty/<VERSION>
  • update website links

Updating the stable links

Since we are not allowed to have symbolic links on the download site we have to log into the machine manually and remove the previous stable directory and 'cp -r <verison> stable-7' to get it updated. Maintaining the conventions we use on the site will allow all 'stable' links to be stable and not needed to update to the latest major Jetty build version.