From dna-commits at lists.jboss.org Fri Sep 26 11:41:03 2008 Content-Type: multipart/mixed; boundary="===============4936790968831511766==" MIME-Version: 1.0 From: dna-commits at lists.jboss.org To: dna-commits at lists.jboss.org Subject: [dna-commits] DNA SVN: r545 - trunk/docs/reference/src/main/docbook/en-US/content. Date: Fri, 26 Sep 2008 11:41:02 -0400 Message-ID: --===============4936790968831511766== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: rhauch Date: 2008-09-26 11:41:02 -0400 (Fri, 26 Sep 2008) New Revision: 545 Modified: trunk/docs/reference/src/main/docbook/en-US/content/development_tools.xml Log: DNA-214 Update documentation to describe the repository, federation, JCR an= d other 0.2 features https://jira.jboss.org/jira/browse/DNA-214 Documented the release build process, and added another 'all' assembly that= contains all of the code Modified: trunk/docs/reference/src/main/docbook/en-US/content/development_t= ools.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/reference/src/main/docbook/en-US/content/development_tools.x= ml 2008-09-26 03:36:03 UTC (rev 544) +++ trunk/docs/reference/src/main/docbook/en-US/content/development_tools.x= ml 2008-09-26 15:41:02 UTC (rev 545) @@ -209,30 +209,6 @@ - - Building releases - - The process of building JBoss DNA releases involves running a Maven bu= ild with some extra parameters. - Building these artifacts, including all documentation and JavaDocs, do= es take extra time, which is why - they are not included in the default parameters. - - - To build the release, issue the following command while in the t= arget/ directory: - - mvn -P assembly clean javadoc:javadoc install - - This command runs "clean", "javadoc:javadoc", and "install" goals usin= g the "assembly" profile, = - which adds the production JavaDocs, the Getting Started document, the = Reference Guide document, = - the Getting Started examples, and several ZIP archives. The order of = the goals is important, - since the "install" goal attempts to include the JavaDoc in the archiv= es. = - - - - Before running the above command, increase the memory available to Ma= ven with this command: - - export MAVEN_OPTS=3D-Xmx256m - - Continuous integration with Hudson @@ -318,4 +294,91 @@ and then check each of the subprojects= that you want to have in your workspace. + + Releasing + + This section outlines the basic process of releasing JBoss DNA. This <= emphasis role=3D"strong">must be done + either by the project lead or only after communicating with the project= lead. + + + Building all artifacts and assemblies + + By default, the project's Maven build process is does not build the documentation, JavaDocs, or assemblies. + These take extra time, and most of our builds don't require them. So = the first step of releasing JBoss DNA + is to use Maven to build all of regular artifacts (e.g., JARs) and the= se extra documents and assemblies. + + + + Before running Maven commands to build the releases, increase the mem= ory available to Maven with this command: + + $ export MAVEN_OPTS=3D-Xmx256m + + + To perform this complete build, issue the following command while in t= he target/ directory: + + $ mvn -P assembly clean javadoc:javadoc install + + This command runs "clean", "javadoc:javadoc", and "install" goals usin= g the "assembly" profile, = + which adds the production JavaDocs, the Getting Started document, the = Reference Guide document, = + the Getting Started examples, and several ZIP archives. The order of = the goals is important, + since the "install" goal attempts to include the JavaDoc in the archiv= es. = + + + After completed, verify that the assemblies under target/= have actually been created and that + they contain the correct information. Now, clean up your workspace: + + $ mvn -Passembly clean + + At this point, we know that the actual Maven build process is building + everything we want and will complete without errors. We can now proce= ed with preparing for the release. + + + + Determine the version to be released + + The version being released should match the &JIRA; road map. Make sure= that all issues related to the release are closed. = + The project lead should be notified and approve that the release is ta= king place. + + + + Release dry run + + The next step is to ensure that all information in the POM is correct = and contains all the information required for + the release process. This is called a dry run, a= nd is done with the Maven "release" plugin: + + $ mvn release:prepare -DdryRun=3Dtrue + + + Release + + = + + + + Building Releases + + Finally, the code can be tagged with the new release, using the follow= ing Subversion command. + Just remember to use the correct <releaseNumber<: + + +$ svn copy https://svn.jboss.org/repos/dna/trunk \ + https://svn.jboss.org/repos/dna/tags/dna-<releaseN= umber< \ + -m "Releasing JBoss DNA <releaseNumber<" + + + Of course, this will copy of HEAD. To copy a particular = revision in trunk/, use + the -r argument with the correct SVN revision number: + + +$ svn copy https://svn.jboss.org/repos/dna/trunk -r<revisionN= umber< \ + https://svn.jboss.org/repos/dna/tags/dna-<releaseN= umber< \ + -m "Releasing JBoss DNA <releaseNumber<" + + + + You can obtain the latest revision number using the $ svn info<= /code> command. + + + + --===============4936790968831511766==--