Skip to main content
Jump to: navigation, search

Difference between revisions of "Jetty/Contributor/Releasing"

(Adding a Link to the Index on the Wiki)
Line 33: Line 33:
== Adding a Link to the Index on the Wiki ==
== 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.
Update [[Jetty/Reference/Index of Generated Release Documents]]; add the newest version to the top of the page. Use the [[Template: Jetty Release Document|Jetty Release Document template]]
== Deploying distribution files to ==
== Deploying distribution files to ==

Revision as of 06:22, 6 July 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 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 server entry in your .m2/settings.xml file. You'll need to have access to the 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 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.

ssh <user>
cd /home/www/jetty/<VERSION>
mv jetty-project/apidocs .
mv jetty-project/xref .
rmdir jetty-project

End result should be api documents accessible from<project version>/api-docs and<project version>/xref

Adding a Link to the Index on the Wiki

Update Jetty/Reference/Index of Generated Release Documents; add the newest version to the top of the page. Use the Jetty Release Document template

Deploying distribution files to

  • download the files in into a directory called 'dist'
  • scp -r dist <user><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:

ssh <user>
cd /home/www/jetty/
rm -fr stable-7
cp -r <version> stable-7

Back to the top