Developer/HowToRelease

generated on 2019-05-24 00:19:28.872671 from the wiki page for Developer/HowToRelease for SUMO git

Packages

for an overview of created packages and contents see Downloads.

Release steps

Below, a list of steps that should be done in order to publish a new release is given. All necessary commits which have no ticket of their own may refer to Issue #563.

Merge phase

Major changes to the SUMO trunk should end about two weeks before the release data. This refers especially to merges of project branches into the trunk. It is also a good idea to inform the developers of dependent software (Veins, VSimRTI, flow etc.) at this stage.

Freeze phase (Release day - 7)

  • check the sources
    • compile, try to remove warnings and commit the patches
    • run checkStyle and commit changed files
    • check the calendar to update copyright statements
    • check whether the TraCI version needs to be incremented and rebuild TraCI constants in python (tools/traci/rebuildConstants.py)
    • check whether the network version needs to be incremented and update the value in NWFrame::MAJOR_VERSION. Netconvert tests need to be updated afterwards.
    • update author information
  • check the regular tests
    • put special attention to the tests which serve as examples, see tests/examples.txt!
    • Win64 and gcc4_64 should have no failing tests, the other platforms are less important
    • If there are failing tests, which are not flagged as known bugs, save them after careful checking or open a ticket and assign a known bug.
    • recheck/rebuild the test networks (if necessary due to netconvert changes)
    • check the tests again
  • check the documentation
    • update the change log
    • generate options documentation from configuration templates using configTemplateToWiki.py (for instance tools/build/configTemplateToWiki.py activitygen | xclip which copies it directly to the clipboard)
    • recheck/rebuild the configuration schemata (if options were added) using tools/xml/rebuildSchemata.py (use the internal build to include all options)
  • check the internal tests (same procedure as above), especially the (to be) published scenarios
  • GitHub
    • add new milestone if necessary
    • check all remaining tickets and assign them to later milestones or to persons.
  • scenarios (optional)
    • prepare scenarios for release if the previous version does not run with the current release or significant changes were made to the scenarios
  • update submodules by running git submodule update and committing the changes if necessary

The trunk is now frozen. All commits which do not refer to an open ticket for the upcoming release need to be made to a separate branch. The freeze phase should not last longer than one week. The goal is to fix all scenarios and have all failing tests fixed, which are not assigned to a later milestone.

Release day - 1

All scenarios should be fixed by now.

  • patch the version information
    • in src/config.h.cmake, also disable the HAVE_VERSION_H macro
    • in configure.ac and build/wix/sumo.wxs
    • commit the changes
  • recheck whether submodules changed by doing git submodule update and committing the changes after careful inspection
  • check the documentation

Release day

The nightly build should have generated all releasable packages. If not, delay the release. (The complete documentation, tests and source distribution build can be achieved via "make dist-complete".) The following things need to be there:

  • the platform independent part of the distribution;
    • source distributions (.tar.gz, .zip) ("make dist", rename)
    • all inclusive distributions (.tar.gz) ("make dist-complete")
  • the binary part of the distribution

If everything is fine:

  • make a new folder in S:\Sumo\Releases
  • make new sourceforge-release
    • make a new release within the sumo package (named "version x.y.z")
    • add files to the release
    • change default download attributes
    • update files at the opensuse build service
  • update the ubuntu ppa (see https://askubuntu.com/questions/642632/how-to-bump-the-version-of-a-package-available-in-another-users-ppa)
    • unzip the source release
    • move the debian dir one level up
    • modify the changelog, using dch (enter an email address which has write access to the ppa and a valid gpg key)
    • run dpkg-buildpackage -S in the sumo dir and dput -f ppa:sumo/stable sumo_version+dfsg1_source.changes one level up
  • scenarios (optional)
  • inform the users about the new release
    • post information about the release to sumo-user@eclipse.org and sumo-announce@eclipse.org
    • tweet and post on facebook
    • trigger update of main website at http://sumo.dlr.de
  • add a new version tag
> git tag -a v0_13_7 -m "tagging release 0.13.7, refs #563"
> git push --tags
  • close the milestone (retargeting open tickets needs to be done manually for now)

After-release cleanup

The trunk is now open for changes again.

  • reenable HAVE_VERSION_H in src/config.h.cmake
  • rename version to "git" in configure.ac and CMakeLists.txt
  • insert a new empty "Git master" section at the top of the change log
  • commit changes
  • drink your favorite beverage