• Developer
  • HowToRelease
HowToRelease

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 #563. All the steps assume you are using bash either natively (Linux, macOS), on WSL or the git bash (or some other mingw bash). Furthermore you should have either your passwords ready or even better ssh keys deployed on all the remote servers in question.

Merge phase#

Major changes to the SUMO trunk should end about two weeks before the release date. 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. - send out mail to sumo-dev informing about the upcoming release so that 'contributed'-authors can check their stuff for compatibility

Freeze phase (Release day - 7)#

  • check the sources
    • compile, try to remove warnings and commit the patches
    • run tools/build_config/checkStyle.py 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 for orphaned tests by running tools/devel/orphaned_tests.py tests and patch testsuites to add them back in
    • check the tests again
  • check the documentation
    • update the ChangeLog
    • generate options documentation and xsd schemata for configuration files using tools/build_config/rebuildConfigDocsAndXsd.py
  • update tools/build_config/templates.py to include any tools that were added or had their compatibility fixed since the last release
  • 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 --remote 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.

  • start and save a new version draft in Zenodo (using the sumo@dlr.de user), in order to reserve a DOI. Don't Publish it yet, and don't upload a file to it!
  • update the ChangeLog again if necessary
  • check the correct email address and list of current ubuntu releases in tools/build_config/ubuntu_release.sh
  • patch the version information using tools/build_config/updateReleaseInfo.py 1.23.1 and double check changes
  • recheck whether submodules changed by doing git submodule update --remote and commit the changes after careful inspection
  • check the documentation
  • check presence of RPMs on https://build.opensuse.org/package/show/science:dlr/sumo_nightly
  • add a new version tag
> git tag -a v0_13_7 -m "tagging release 0.13.7, refs #563"
> git push --tags

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".) The following things need to be in the S:\daily directory:

If everything is fine:

  • make a new folder in S:\Releases
  • make new sumo.dlr.de-release
    • copy the folder from S:\Releases to the releases dir scp -r /s/Releases/1.23.1 delphi@ts-sim-front-ba.intra.dlr.de:docs/releases
  • update the eclipse.dev/sumo website
    • modify the version number (Version) and the DOI number (DOI) in config.yaml in the Default Parameters section
  • make new sourceforge-release
    • create a shell ssh -t <user>,sumo@shell.sf.net create and log off immediately
    • copy the files scp -O -r /s/Releases/1.23.1 <user>,sumo@shell.sf.net:
    • login again, delete the wheels and move the files into the right directory mv 1.23.1 /home/frs/project/sumo/sumo/"version 1.23.1"
    • change default download attributes by logging in on the web browser at https://sourceforge.net/projects/sumo/files/sumo/version%201.23.1/ and clicking on the circled "i" after each file
      • the default for Windows is sumo-win64extra-1.23.1.msi, for macOS sumo-1.23.1.pkg and for all the others sumo-src-1.23.1.tar.gz
  • finish the Zenodo version draft, by uploading the sumo-src-1.23.1.tar.gz, adding the release info (can also be done later) and publishing it
  • Create a new Eclipse release at https://projects.eclipse.org/projects/automotive.sumo (after login there should be a "Create Release" button)
  • create a new entry in elib
  • 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)
    • this assumes you have the devscripts package as well as all sumo dependencies installed
    • unzip the special source release tar xzf sumo_1.23.1.orig.tar.gz
    • run cd sumo-1.23.1 && tools/build_config/ubuntu_release.sh and enter the release comment
  • start a pull request against winget
  • upload the wheels to PyPI using twine upload /s/daily/wheels/*1.23.1*.whl
  • scenarios (optional)
  • inform the users about the new release
  • close the milestone (retargeting open tickets needs to be done manually for now)
  • add the latest version to the "software version identifier" statement in Wikidata (this will update the Wikipedia articles about SUMO), making sure to select the latest version as "preferred rank" and setting the previous one to "normal rank".

After-release cleanup#

The trunk is now open for changes again.

  • wait for the automated flatpak pull request to appear and built, then accept it
  • re-enable HAVE_VERSION_H in src/config.h.cmake
  • rename version to "git" in CMakeLists.txt
  • insert a new empty "Git Main" section at the top of the ChangeLog
  • commit changes
  • drink your favorite beverage and/or eat cake