Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Pre-release code changes:
    1. Switch off Wicket development mode (gui/admin-gui/src/main/webapp/WEB-INF/web.xml)
    2. Switch off checks in InternalsConfig
    3. Check versions of ConnId and the connectors. If there are any snapshorts then release these first and fix the versions.
  2. Pre-release check:
    1. Check Jenkins state
    2. Check that overlay projects work
    3. Check that WebLogic deployment works
    4. Fresh clone/pull of the source code, fresh build (delete local maven repository before build). Run all tests. Make sure that the code is ship-shape.
    5. Run as standalone and test Tomcat deployment
    6. Check outstanding Jira issues
    7. Check that DB scripts are up-to-date
      1. ask someone to review the scripts
      2. check that there are no scripts for older releases
      3. check that config/sql/_all has both "create" and "upgrade" scripts for every database
    8. Check changes in init objects (admin-gui/src/main/resources/initial-objects).
      1. git log --stat gui/admin-gui/src/main/resources/initial-objects
      2. Document changes in release notes
      3. Copy the new objects into config/initial-objects
    10. Review Notice file, make sure all copyright notices are there
    11. Make sure there is enough space on website to hold the release
  3. Do the "source code" release:
    1. Change maven version to final (non-snapshot) version (see the use of "version" plugin below), e.g. mvn versions:set -DnewVersion=3.4
    2. Change maven version also in samples/model-client-sample, weblogic-build, testing/minipoint
    3. Change plugin dependency version in infra/schema/pom.xml, model/model-client/pom.xml (usually not needed any more)
    4. Check that there are no SNAPSHOT versions in pom.xml dependencies (find . -name "pom.xml" -exec grep SNAPSHOT {} \; -print)
    5. Change version in XSD schemas (especially common-*.xsd) - remove SNAPSHOT
    6. mvn versions:commit
    7. Clean local maven repo and rebuild with tests - to make sure nothing was broken by changing the version (for 3.4.x build with java7!)
    8. git commit
    9. Git tag: v3.4 (not midpoint-v3.4 !!!): git tag -a v3.4 -m 'Version 3.4 (VersionName)'
    10. Rebuild and package midpoint: mvn clean install package -DskipTests=true (Important! for 3.4.x build with Java7)
    11. Save the binary distribution for upload (important! build only after tagging, we need correct "git describe"):
      1. dist/target/midpoint-*-dist.*
      2. dist/midpoint-api/target/midpoint-api-3.4.jar
      3. dist/midpoint-api/target/midpoint-api-3.4-javadoc.jar
      4. infra/schema/target/
    12. Generate full javadoc and save it
      1. mvn javadoc:aggregate-jar
      2. target/midpoint-3.4-javadoc.jar
    13. deploy midpoint (both standalone and tomcat), check that it starts OK, roughly test that GUI works
    14. Check that the version numbers are displayed correctly in the GUI (in "About")
    15. git push; git push origin v3.4
    16. Publish maven artifacts to nexus "releases" repository using mvn deploy -DskipTests=true (you need to have nexus username/password in maven settings.xml)
    17. Create a support branch, e.g. support-3.4 (if not created already): git checkout -b support-3.4; git push -u origin support-3.4; git checkout master
  4. Master branch
    1. Change maven version to next snapshot, e.g. 3.5-SNAPSHOT (also change in model-client-sample, plugins and others as described above)
    2. Change version in XSD schemas (especially common-*.xsd) - e.g. to 3.5-SNAPSHOT
    3. commit
    4. Tag the beginning of new development, e.g. v3.5devel (used in "git describe" strings): git tag -a v3.5devel -m 'Start of 3.5 development'
    5. git push, git push origin v3.5devel
    6. Update README and to indicate development branch
  5. Support branch
    1. Change maven version to next support snapshot, e.g. 3.4.1-SNAPSHOT
    2. commit
    3. Tag the beginning of support, e.g. v3.4support
    4. git push, git push origin v3.4support
    5. Update README and to indicate support branch
    6. Reconfigure bamboo support build plan
  6. Evolveum website:
    1. Upload binary distribution to Evolveum website (download section): dist/target/midpoint-* -> mercurius:/var/www/evolveum/downloads/midpoint/3.4
    2. Upload API javadoc to www:
      1. copy dist/midpoint-api/target/midpoint-api-3.4-javadoc.jar -> mercurius:/var/www/evolveum/downloads/midpoint/3.4
      2. mercurius: mkdir midpoint-api-3.4-javadoc; cd midpoint-api-3.4-javadoc; unzip ../midpoint-api-3.4-javadoc.jar
    3. Upload full javadoc to www:
      1. copy target/midpoint-3.4-javadoc.jar -> mercurius:/var/www/evolveum/downloads/midpoint/3.4
      2. mercurius: mkdir midpoint-3.4-javadoc; cd midpoint-3.4-javadoc; unzip ../midpoint-3.4-javadoc.jar
    4. Upload schemadoc to www:
      1. copy infra/schema/target/ -> mercurius:/var/www/evolveum/downloads/midpoint/3.4
      2. mercurius: mkdir schema-3.4-schemadoc; cd schema-3.4-schemadoc; unzip ../
    5. Find someone to independently test the uploaded binary
    6. Update symlinks in /var/www/evolveum/downloads/midpoint/latest
    7. Update website links (download page, news, ...):
      1. Pages -> Download midPoint: add new row (and try not to get mad about row classes)
      2. Log out!
      3. Click through the website to verify it works.
  7. Update wiki links:
    1. Release notes (midPoint Releases): copy the "UNDER DEVELOPMENT" page to a next version, update the current version page
    2. Update midPoint History
    3. Update Roadmap
    4. Update Home
    5. Update SchemaDoc
    6. Update JavaDoc page
    7. Update Interfaces (each individual interface page)
    8. Update Identity Connectors if needed
    9. Update Script Expression Functions and subpages
    10. Update Configuration Samples
    11. Update Model Web Service Client Sample
  8. Update project versions in JIRA
  9. Update support branch name in Jenkins
  10. Update documents
    1. midPoint overview presentation
    2. datasheet
  11. Switch overlay sample projects to the released versions
    1. set versions, tag, push, ....
    2. update Customization With Overlay Project page
  12. Send announce to mailing list
  13. Write blog about new release

ConnId/Polygon Framework Release Checklist