Skip to main content
Jump to: navigation, search

Difference between revisions of "Gemini/Blueprint/Releasing"

(Release Instructions)
m
 
(24 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 has worked in the past; now using 3.0.3.
+
=== 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 - update version:
+
Make sure the changelog.txt is up to date regarding the included changes of the release.
# mvn versions:set -DnewVersion=1.0.1.M01
+
# find . -name "*.versionsBackup" -exec rm {} \;
+
# manually edit version in release/pom.xml, docs/pom.xml, and integration-tests/bundles/embedded.ns.bundle/pom.xml
+
# check Spring version properties in main pom.xml
+
# update changelog and its 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 core/src/resources/main/resources/META-INF/schema (especially the aliases)
+
## update xml files in META-INF/spring which refer to the latest version of the eclipse-gemini-blueprint.xsd schema
+
  
Step 2 - build and test:
 
# switch to Java 5 (see http://www.s-seven.net/java_15_mountain_lion if you are on a Mac)
 
# Build and test using:
 
## mvn clean install -Pit,felix
 
## mvn clean install -Pit,knopflerfish // a few integration tests currently fail, but this could be KF setup problem
 
## mvn clean install -Pit,equinox
 
# switch back to Java 6 or later
 
  
Step 3 - generate release artifacts, tag, increment version:
+
=== Step 2 - execute staging release ===
# generate javadocs - mvn javadoc:aggregate javadoc:jar - aggregated javadoc in target/site/apidocs/
+
Execute the Hudson release staging build (https://hudson.eclipse.org/gemini/view/blueprint/job/gemini-blueprint-stage-release/). After execution, test the staged artifacts.
# collect sources into JARs - mvn source:jar (outputDirectory doesn't work)
+
Go to https://oss.sonatype.org/ and switch to the nexus managed repositories:
# generate documentation - cd docs; mvn clean pre-site; cd .. (used to be docbkx:generate-html docbkx:generate-pdf) // output in docs/target/site/
+
# switch to Java 5
+
# generate Maven repo (when the Gemini maven repo is open for business):
+
## For full releases (not milestone or RC) may be necessary to change distributionManagement repository to point at release repository
+
## mvn -Pequinox -Dmaven.test.skip=true deploy -DperformRelease -DaltDeploymentRepository=local::default::file:/tmp/gemini-blueprint/1.0.1.M01/repo
+
# run release project - cd release; rm -rf target; mvn -P equinox package -Dmaven.test.skip=true
+
# run the mvn deploy target above but this time without the altDeploymentRepository (for milestones) to get the same binaries in the zip and in the repo
+
# switch back to Java 6 or later
+
# tag the git repo
+
# increase version to 1.0.1.BUILD-SNAPSHOT
+
## mvn versions:set -DnewVersion=1.0.1.BUILD-SNAPSHOT
+
## find . -name "*.versionsBackup" -exec rm {} \;
+
## manually edit version in release/pom.xml, docs/pom.xml, and integration-tests/bundles/embedded.ns.bundle/pom.xml
+
## find . -name "boot-bundles.properties" and update ignore.gemini.blueprint.version to 1.0.1.BUILD-SNAPSHOT
+
  
Step 4 - publish:
+
[[File:gemini-blueprint-releasing-nexus-managed-repos.png]]
# upload ZIP to Eclipse
+
 
# update the downloads page
+
There, select the orgeclipsegemini-[NNN] repository created by the build. Download and test the artifacts contained therein:
# announce forums and mailing list
+
- 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.
  
 
[[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.

Back to the top