Generating a new VI release

=== DRAFT ===

When creating a new release then these are the normal steps one should take. The guidelines below take v2.0.0 as an example version.

Manual work flow

1. Check and update in the Modelica Library
   • version and date: following annotations in the VehicleInterfaces (or main package.mo):
     • version
     • versionDate
     • dateModified
   • library description in the VehicleInterfaces (or main package.mo): i.e. package VehicleInterfaces "VehicleInterfaces Library (Version 2.0.0) - Interface definitions ...
   • dependencies: annotation uses in the VehicleInterfaces (or main package.mo).
   • conversion: annotation conversion in the VehicleInterfaces (or main package.mo).
   • copyright date in VehicleInterfaces.UsersGuide.License.
   • release notes in VehicleInterfaces.UsersGuide.ReleaseNotes.
2. Check proper version number and date in
   • VehicleInterfaces/libraryinfo.mos
3. Update the copyright date/year in the following files:
   • LICENSE.txt located in the GitHub repository and intended to have transparent information on root and front page.
   • Files in VehicleInterfaces/Resources/Licenses, intended for the tools to pack the necessary license information when creating derived work (imagine FMUs).
4. Commit / pull / pull request / merge the abovementioned changes accordingly into master.
5. Checkout the master branch and make sure it is in sync with the official upstream repository https://github.com/modelica/VehicleInterfaces

    $ git checkout master
    $ git pull upstream

6. Tag the release and also annotate the tag at the same time with some meaningful message. Do not push the tag yet.

   $ git tag -a -m "Final release 2.0.0 of the VehicleInterfaces" v2.0.0

7. Generate a zip archive of the tagged version. Thanks to the settings in the .gitattributes file this will
   • fill in place holders like revisionId automatically

   $ git archive --format=zip -o /tmp/VehicleInterfaces_v2.0.0.zip v2.0.0

8. Double check the created zip file and if satisfied push the tag to upstream

   $ git push origin v2.0.0

9. The directories inside the zip archive need to be renamed:
   • VehicleInterfaces → VehicleInterfaces 2.0.0
10. Go to the Releases page and edit the pushed tag and add the created zip file as an asset.