Skip to main content
Jump to: navigation, search

Difference between revisions of "Gemini/Blueprint/Releasing"

(Release Instructions)
m
 
(47 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Building Gemini Blueprint ==
+
== Releasing Gemini Blueprint 2.x  ==
  
== Release Instructions ==
+
Pre-requisites: JDK 1.8. Maven 3.3.x.
  
Pre-req's: Java 5 in addition to preferred Java version. Maven 2.0.x is known to work; 3.0.x may work.
+
=== Step 1 - make sure artifacts are prepared ===
 +
The docs/ module is independent of the maven module structure any may have to be set to the release target version manually in the pom.xml. The docs module
 +
must then be build manually. The resulting generated documentation in target/site/reference must be copied to the gemini website.
  
For example, for 1.0.1.M01:
+
mvn docbkx:generate-html@single-page &&
 +
mvn docbkx:generate-html@multi-page
  
Step 1:
+
Make sure the changelog.txt is up to date regarding the included changes of the release.
# git checkout -b milestone-prep
+
# mvn versions:set -DnewVersion=1.0.1.M01
+
# find . -name "*.versionsBackup" -exec rm {} \;
+
# check Spring version properties in main pom.
+
# update changelog version/date
+
# find . -name "boot-bundles.properties" and update ignore.gemini.blueprint.version to 1.0.1.M01
+
# if blueprint schema needs to be changed:
+
## add the file gemini-blueprint-<version>.xsd to core/src/main/resources/org/eclipse/gemini/blueprint/config
+
## update the version attribute of the xsd:schema element of the above file
+
## update .schema files (especially the aliases) // There are no .schema files
+
## update xml files in META-INF/spring which refer to the latest version of the eclipse-gemini-blueprint.xsd schema
+
# switch to Java 5
+
# disconnect network
+
# Build and test using:
+
## mvn clean install -Pit,equinox
+
# reconnect network
+
# switch back to Java 6 or later
+
# <work in progress>
+
  
The following are old notes for Spring DM. Need to update them for Gemini Blueprint!
 
  
Spring Dynamic Modules release procedure
+
=== Step 2 - execute staging release ===
-----
+
Execute the Hudson release staging build (https://hudson.eclipse.org/gemini/view/blueprint/job/gemini-blueprint-stage-release/). After execution, test the staged artifacts.
Step 0:
+
Go to https://oss.sonatype.org/ and switch to the nexus managed repositories:
# disable CI builds (trunk and NIGHTLY) // No need since CI builds do not interfere with local.
+
  
Step 1:
+
[[File:gemini-blueprint-releasing-nexus-managed-repos.png]]
# switch to Java5
+
# change version from SNAPSHOT to stable inside poms // Done. mvn versions:set -DnewVersion=xxx then remove *.versionsBackup files
+
# check Spring version properties in main pom.
+
# update changelog version/date// Done.
+
# change test support boot bundles version in properties // Done.
+
# if blueprint schema needs to be changed:
+
## add the file gemini-blueprint-<version>.xsd to core/src/main/resources/org/eclipse/gemini/blueprint/config
+
## update the version attribute of the xsd:schema element of the above file
+
## update .schema files (especially the aliases) // There are no .schema files
+
## update xml files in META-INF/spring which refer to the latest version of the eclipse-gemini-blueprint.xsd schema
+
# disconnect network (to ensure network is not needed to access the xsd schemas)
+
# make sure tests work with it // What test targets need to be run? Maven 2.0.x used in the past
+
# reconnect the network
+
  
Step 2: Generate release artifacts
+
There, select the orgeclipsegemini-[NNN] repository created by the build. Download and test the artifacts contained therein:
# generate javadocs (connected to internet) - mvn javadoc:javadoc javadoc:jar
+
- Are all expected release artifacts contained?
# add sources - mvn source:jar (outputDirectory doesn't work)
+
- Are the artifacts versioned as expected?
# add libs - mvn dependency:copy-dependencies -DoutputDirectory=../target/libs -P equinox,samples
+
## this allows duplicates to be removed
+
## assemble plugin will pick this location and include in the distributed artifacts
+
# switch to java 6
+
# generate documentation - cd docs; mvn clean pre-site (used to be docbkx:generate-html docbkx:generate-pdf)
+
# switch back to java 5
+
  
Public (NOT RC, Mx) releases: 
+
=== Step 3 - publish the release (or drop it) ===
change distributionManagement to maven.springframework.org/release
+
  
mvn -P equinox -Dmaven.test.skip=true deploy -DperformRelease
+
If  you are satisfied with the staged artifacts, copy the staging repo id (e.g., "orgeclipsegemini-1001" in /service/local/repositories/orgeclipsegemini-1001/content/). Provide this as a parameter to the Gemini Blueprint Publish Release Job (https://hudson.eclipse.org/gemini/job/gemini-blueprint-publish-release/). This will irrevocably release the artifacts to maven central. In case you want to discard the staged artifacts execute the Gemini Blueprint Discard Release Job (https://hudson.eclipse.org/gemini/job/gemini-blueprint-discard-release/) with the same repository ID and the staged release version.
  -DaltDeploymentRepository=local::default::file:/d:/work/study/osgi/repo during the deploy command.
+
              <maven-sync-root></maven-sync-root> is a checkout of https://springframework.svn.sourceforge.net/svnroot/springframework/repos/repo
+
 
+
Milestone releases:
+
mvn -P equinox -Dmaven.test.skip=true deploy -DperformRelease
+
  -DaltDeploymentRepository=local::default::file:/e:/tmp/spring-osgi.dist/[version]/repo during the deploy command.
+
 
+
# run release project - cd release; rm -rf target; mvn -o -P equinox package -Dmaven.test.skip=true
+
## add cglib (2.2.0)
+
## add jetty/tomcat activator sources+jars
+
# check version and format on both javadocs & docs
+
# update maven archetype
+
# update readme.txt/readme-libraries.txt
+
# final search for XXX-SNAPSHOT to see whether it is referred to somewhere
+
 
+
# the assembly already created the artifacts under release/target. You just need to add the sources under src/ folder.
+
# add Incubator in the name
+
# commit sources with stable revisions
+
# do SVN export to provide the sources (should find a better way) and add them to the with-dependencies archive. Check what modules should be excluded (docs/release/lib) - archive the sources into a zip (since building causes leftovers)
+
# delete local maven repo
+
# try to build the project from the sources
+
# if everything works out okay, put the sources in the archive,make tag and increase version to 1.1.X-SNAPSHOT tag
+
 
+
# run the mvn deploy target above but this time w/o the altDeploymentRepository (for milestones)
+
## to get the same binaries in the zip and in the repo
+
 
+
Step 3: Upload artifacts
+
# create zip for javadocs and docs
+
# log into www.springframework.org
+
# go to static.spring/osgi/docs
+
# create XXX version
+
# unzip javadocs and docs
+
# update online schemas at static.spring/schema/osgi*
+
 
+
# put *.txt files in there
+
# verify links inside the docs
+
 
+
# put zip with and without dependencies on SF (as hidden artifact)
+
# download publish zip (normally wait 1-3 minutes for it)
+
 
+
# make SVN tag for the version
+
# increment project version back to SNAPSHOT and commit
+
 
+
# update 'current' symlink to the new version
+
# add versioned schema on internet
+
 
+
# update the home page
+
# announce forums and mailing list
+
 
+
# upload ZIP to Eclipse
+
C:\tools\putty>pscp.exe -scp -v e:\tmp\spring-osgi.dist\gemini\1.0.0.M1\gemini-blueprint-incubation-1.0.0.M1.zip <committerId>@download1.eclipse.org:downloads/blueprint/
+
  
 
[[Category:Gemini Blueprint|Blueprint]]
 
[[Category:Gemini Blueprint|Blueprint]]

Latest revision as of 18:38, 2 April 2018

Releasing Gemini Blueprint 2.x

Pre-requisites: JDK 1.8. Maven 3.3.x.

Step 1 - make sure artifacts are prepared

The docs/ module is independent of the maven module structure any may have to be set to the release target version manually in the pom.xml. The docs module must then be build manually. The resulting generated documentation in target/site/reference must be copied to the gemini website.

mvn docbkx:generate-html@single-page && mvn docbkx:generate-html@multi-page

Make sure the changelog.txt is up to date regarding the included changes of the release.


Step 2 - execute staging release

Execute the Hudson release staging build (https://hudson.eclipse.org/gemini/view/blueprint/job/gemini-blueprint-stage-release/). After execution, test the staged artifacts. Go to https://oss.sonatype.org/ and switch to the nexus managed repositories:

Gemini-blueprint-releasing-nexus-managed-repos.png

There, select the orgeclipsegemini-[NNN] repository created by the build. Download and test the artifacts contained therein: - Are all expected release artifacts contained? - Are the artifacts versioned as expected?

Step 3 - publish the release (or drop it)

If you are satisfied with the staged artifacts, copy the staging repo id (e.g., "orgeclipsegemini-1001" in /service/local/repositories/orgeclipsegemini-1001/content/). Provide this as a parameter to the Gemini Blueprint Publish Release Job (https://hudson.eclipse.org/gemini/job/gemini-blueprint-publish-release/). This will irrevocably release the artifacts to maven central. In case you want to discard the staged artifacts execute the Gemini Blueprint Discard Release Job (https://hudson.eclipse.org/gemini/job/gemini-blueprint-discard-release/) with the same repository ID and the staged release version.

Copyright © Eclipse Foundation, Inc. All Rights Reserved.