Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Gemini/Blueprint/Releasing"

(→‎Release Instructions)
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Building Gemini Blueprint ==
 
== Building Gemini Blueprint ==
  
−
== Release Instructions ==
+
== Release Instructions for 2.0.x  ==
 +
 
 +
Pre-req's: Java 6. Maven 3.0.3.
 +
 
 +
For example, for 2.0.0.M01:
 +
 
 +
Step 1 - update version:
 +
 
 +
#update changelog and its version/date
 +
#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
 +
# branch the git repo
 +
#mvn versions:set -DnewVersion=2.0.0.M01
 +
#find . -name "*.versionsBackup" -exec rm {} \;
 +
#manually edit version in release/pom.xml docs/pom.xml integration-tests/bundles/embedded.ns.bundle/pom.xml
 +
#check Spring version properties in main pom.xml: cat pom.xml | grep spring.*version
 +
#find . -name "boot-bundles.properties" and update ignore.gemini.blueprint.version to 2.0.0.M01: e.g. find . -name "boot-bundles.properties" | grep -v target | xargs subl
 +
 
 +
Step 2 - build and test:
 +
 
 +
#Build and test using:
 +
##mvn clean install -Pit,felix
 +
##mvn clean install -Pit,knopflerfish
 +
##mvn clean install -Pit,equinox
 +
 
 +
Step 3 - generate release artifacts, tag, increment version:
 +
 
 +
#generate javadocs - mvn javadoc:aggregate javadoc:jar - aggregated javadoc in target/site/apidocs/
 +
#collect sources into JARs - mvn source:jar (outputDirectory doesn't work)
 +
#generate documentation - cd docs; mvn clean pre-site; cd .. (used to be docbkx:generate-html docbkx:generate-pdf) // output in docs/target/site/
 +
#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/2.0.0.M01/repo
 +
#run release project - cd release; rm -rf target; mvn -P equinox package -Dmaven.test.skip=true; cd ..
 +
#commit the changes
 +
#tag the git repo
 +
#push the changes and the tag
 +
# checkout master
 +
# delete the branch
 +
 
 +
Step 4 - publish:
 +
 
 +
#upload ZIP to Eclipse
 +
#For full releases, Zip/upload/unzip the Maven repository - see [http://wiki.eclipse.org/Gemini/mvn Gemini Maven Repository]
 +
#update the downloads page
 +
#store the documentation in the Gemini Blueprint web site
 +
#update the documentation page
 +
#announce on the forum and mailing list
 +
 
 +
== Release Instructions for 1.0.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.
 
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.
Line 10: Line 62:
 
# mvn versions:set -DnewVersion=1.0.1.M01
 
# mvn versions:set -DnewVersion=1.0.1.M01
 
# find . -name "*.versionsBackup" -exec rm {} \;
 
# 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
 
# check Spring version properties in main pom.xml
 
# update changelog and its version/date
 
# update changelog and its version/date
Line 20: Line 73:
  
 
Step 2 - build and test:
 
Step 2 - build and test:
−
# switch to Java 5
+
# switch to Java 5 (see http://www.s-seven.net/java_15_mountain_lion if you are on a Mac)
 
# Build and test using:
 
# Build and test using:
 
## mvn clean install -Pit,felix
 
## mvn clean install -Pit,felix
Line 34: Line 87:
 
# generate Maven repo (when the Gemini maven repo is open for business):
 
# 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
 
## For full releases (not milestone or RC) may be necessary to change distributionManagement repository to point at release repository
−
## mvn -P equinox -Dmaven.test.skip=true deploy -DperformRelease -DaltDeploymentRepository=local::default::file:/tmp/gemini-blueprint/1.0.1.M01/repo
+
## 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 release project - cd release; rm -rf target; mvn -P equinox package -Dmaven.test.skip=true; cd ..
−
# 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
 
# switch back to Java 6 or later
 +
# commit the changes
 
# tag the git repo
 
# tag the git repo
−
# increase version to 1.0.2.BUILD-SNAPSHOT
+
# push the changes and tag
 +
# 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:
 
Step 4 - publish:
 
# upload ZIP to Eclipse
 
# upload ZIP to Eclipse
 
# update the downloads page
 
# update the downloads page
−
# announce forums and mailing list
+
# store the documentation in the Gemini Blueprint web site
 +
# update the documentation page
 +
# announce on the forum and mailing list
  
 
[[Category:Gemini Blueprint|Blueprint]]
 
[[Category:Gemini Blueprint|Blueprint]]

Revision as of 11:55, 20 March 2013

Building Gemini Blueprint

Release Instructions for 2.0.x

Pre-req's: Java 6. Maven 3.0.3.

For example, for 2.0.0.M01:

Step 1 - update version:

  1. update changelog and its version/date
  2. if blueprint schema needs to be changed:
    1. add the file gemini-blueprint-<version>.xsd to core/src/main/resources/org/eclipse/gemini/blueprint/config
    2. update the version attribute of the xsd:schema element of the above file
    3. update core/src/resources/main/resources/META-INF/schema (especially the aliases)
    4. update xml files in META-INF/spring which refer to the latest version of the eclipse-gemini-blueprint.xsd schema
  3. branch the git repo
  4. mvn versions:set -DnewVersion=2.0.0.M01
  5. find . -name "*.versionsBackup" -exec rm {} \;
  6. manually edit version in release/pom.xml docs/pom.xml integration-tests/bundles/embedded.ns.bundle/pom.xml
  7. check Spring version properties in main pom.xml: cat pom.xml | grep spring.*version
  8. find . -name "boot-bundles.properties" and update ignore.gemini.blueprint.version to 2.0.0.M01: e.g. find . -name "boot-bundles.properties" | grep -v target | xargs subl

Step 2 - build and test:

  1. Build and test using:
    1. mvn clean install -Pit,felix
    2. mvn clean install -Pit,knopflerfish
    3. mvn clean install -Pit,equinox

Step 3 - generate release artifacts, tag, increment version:

  1. generate javadocs - mvn javadoc:aggregate javadoc:jar - aggregated javadoc in target/site/apidocs/
  2. collect sources into JARs - mvn source:jar (outputDirectory doesn't work)
  3. generate documentation - cd docs; mvn clean pre-site; cd .. (used to be docbkx:generate-html docbkx:generate-pdf) // output in docs/target/site/
  4. generate Maven repo (when the Gemini maven repo is open for business):
    1. For full releases (not milestone or RC) may be necessary to change distributionManagement repository to point at release repository
    2. mvn -Pequinox -Dmaven.test.skip=true deploy -DperformRelease -DaltDeploymentRepository=local::default::file:/tmp/gemini-blueprint/2.0.0.M01/repo
  5. run release project - cd release; rm -rf target; mvn -P equinox package -Dmaven.test.skip=true; cd ..
  6. commit the changes
  7. tag the git repo
  8. push the changes and the tag
  9. checkout master
  10. delete the branch

Step 4 - publish:

  1. upload ZIP to Eclipse
  2. For full releases, Zip/upload/unzip the Maven repository - see Gemini Maven Repository
  3. update the downloads page
  4. store the documentation in the Gemini Blueprint web site
  5. update the documentation page
  6. announce on the forum and mailing list

Release Instructions for 1.0.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.

For example, for 1.0.1.M01:

Step 1 - update version:

  1. mvn versions:set -DnewVersion=1.0.1.M01
  2. find . -name "*.versionsBackup" -exec rm {} \;
  3. manually edit version in release/pom.xml, docs/pom.xml, and integration-tests/bundles/embedded.ns.bundle/pom.xml
  4. check Spring version properties in main pom.xml
  5. update changelog and its version/date
  6. find . -name "boot-bundles.properties" and update ignore.gemini.blueprint.version to 1.0.1.M01
  7. if blueprint schema needs to be changed:
    1. add the file gemini-blueprint-<version>.xsd to core/src/main/resources/org/eclipse/gemini/blueprint/config
    2. update the version attribute of the xsd:schema element of the above file
    3. update core/src/resources/main/resources/META-INF/schema (especially the aliases)
    4. 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:

  1. switch to Java 5 (see http://www.s-seven.net/java_15_mountain_lion if you are on a Mac)
  2. Build and test using:
    1. mvn clean install -Pit,felix
    2. mvn clean install -Pit,knopflerfish // a few integration tests currently fail, but this could be KF setup problem
    3. mvn clean install -Pit,equinox
  3. switch back to Java 6 or later

Step 3 - generate release artifacts, tag, increment version:

  1. generate javadocs - mvn javadoc:aggregate javadoc:jar - aggregated javadoc in target/site/apidocs/
  2. collect sources into JARs - mvn source:jar (outputDirectory doesn't work)
  3. generate documentation - cd docs; mvn clean pre-site; cd .. (used to be docbkx:generate-html docbkx:generate-pdf) // output in docs/target/site/
  4. switch to Java 5
  5. generate Maven repo (when the Gemini maven repo is open for business):
    1. For full releases (not milestone or RC) may be necessary to change distributionManagement repository to point at release repository
    2. mvn -Pequinox -Dmaven.test.skip=true deploy -DperformRelease -DaltDeploymentRepository=local::default::file:/tmp/gemini-blueprint/1.0.1.M01/repo
  6. run release project - cd release; rm -rf target; mvn -P equinox package -Dmaven.test.skip=true; cd ..
  7. switch back to Java 6 or later
  8. commit the changes
  9. tag the git repo
  10. push the changes and tag
  11. increase version to 1.0.1.BUILD-SNAPSHOT
    1. mvn versions:set -DnewVersion=1.0.1.BUILD-SNAPSHOT
    2. find . -name "*.versionsBackup" -exec rm {} \;
    3. manually edit version in release/pom.xml, docs/pom.xml, and integration-tests/bundles/embedded.ns.bundle/pom.xml
    4. find . -name "boot-bundles.properties" and update ignore.gemini.blueprint.version to 1.0.1.BUILD-SNAPSHOT

Step 4 - publish:

  1. upload ZIP to Eclipse
  2. update the downloads page
  3. store the documentation in the Gemini Blueprint web site
  4. update the documentation page
  5. announce on the forum and mailing list
Retrieved from "https://wiki.eclipse.org/index.php?title=Gemini/Blueprint/Releasing&oldid=331672"

Back to the top