How to release openHAB - vpjuslin/openhab GitHub Wiki

Follow these steps if you want to release a new version of openHAB. Later we plan to leverage the Maven Release Plugin to facilitate these steps.

  1. Pull the latest state from the repository into a fresh and empty directory

     git clone [email protected]:openhab/openhab.git
    
  2. Open a command-line and go to the openhab directory

  3. Set project version to release version with the Tycho Versions plugin

     export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=1024m"; mvn -P prepare-release initialize -DnewVersion=1.x.0
    
  4. Manually change ./products/org.openhab.runtime.product/category.xml file. Replace 1.x.0.qualifier by 1.x.0

  5. Manually change ./products/org.openhab.designer.product/category.xml file. Replace 1.x.0.qualifier by 1.x.0

  6. Manually change version in .//bundles/archetype/org.openhab.archetype.binding/pom.xml file.

  7. Manually change version in .//bundles/archetype/org.openhab.archetype.action/pom.xml file.

  8. Execute a Maven build

     mvn -P deploy clean deploy -Drepo.id=cloudbees-public-release-repo -Drepo.url=dav:https://repository-openhab.forge.cloudbees.com/release/1.x.0 -Dp2.repo.dir=p2 -Dapt.repo.dir=apt-repo
    
  9. Install and extensively test the created binaries

  10. Commit the changed files

     git commit -a -m "prepare for 1.x.0 release"
    
  11. Create a release tag with pattern v<version>

     git tag v1.x.0
    
  12. Increment to next development version

     mvn -P prepare-next-snapshot initialize -DnewVersion=1.y.0.qualifier
    
  13. Manually change ./products/org.openhab.runtime.product/category.xml file. Replace 1.y.0 by 1.y.0.qualifier

  14. Manually change ./products/org.openhab.designer.product/category.xml file. Replace 1.y.0 by 1.y.0.qualifier

  15. Manually change version in .//bundles/archetype/org.openhab.archetype.binding/pom.xml file.

  16. Manually change version in .//bundles/archetype/org.openhab.archetype.action/pom.xml file.

  17. Execute a Maven build with goals clean verify to assure that everything builds

     mvn clean verify
    
  18. Commit the changes

     git commit -a -m "increment to next development version 1.y.0"
    
  19. Push the changes including the tag to the server

     git push origin master --tags
    
  20. Switch to the root directoy of openHAB

Manual Steps to walk through after the Release-Build

  • check if start.sh and start_debug.sh has been unpacked with correct file permissions (0755)
  • Issue a rough Smoke-Test (unpack runtime and demo, start runtime, access Classic-UI)
  • check if Designer (for at least xxx and Windows) works
  • upload deb and p2 Repository

Channels to inform about the new Release

  1. News-Section on index.html
  2. Google-Group
  3. Twitter
  4. Google+ Page
  5. Google Community
  6. KNX-User-Forum

to be continued …

⚠️ **GitHub.com Fallback** ⚠️