Skip to content

Release Version

Jump to bottom Edit New page
Michael Wetter edited this page Oct 24, 2013 · 23 revisions

Making a release

Making a new release requires administrator permission.

Modelica library

To make a release of the Modelica library, proceed as follows:

  1. Merge all changes to the release branch.

  2. On the release branch, update the first lines in the file Buildings/package.mo, such as

    annotation (
version="1.0",
versionBuild=2,
versionDate="2011-11-04",
dateModified = "2011-12-08",
uses(Modelica(version="3.2")),
conversion(
  from(version="0.12", 
       script="modelica://Buildings/Resources/Scripts/Dymola/ConvertModelica_from_0.12.0_to_0.13.mos")),

    Use versionBuild=0 prior to any release, versionBuild=1 for the first release of a version, and increment it for every release of a bug fix that is compatible with previous releases of the same version number.

    The keyword versionDate is only changed when version changes. A new versionBuild does not change versionDate, but it does update dateModified in the format above, which can be processed by Modelica tools.

  3. On the release branch, change README.md to update the line

    Download [Buildings Library 1.4 build 1 (2013-01-31)](https://github.com/lbl-srg/modelica-buildings/archive/v1.4+build.1.zip)

  4. Make sure that the conversion script, such as ConvertModelica_from_0.12.0_to_0.13.mos, contains all update commands.

  5. Run the script bin/checkRelease.py to check for invalid syntax.

  6. Run the unit tests.

  7. Update the user guide by typing

    cd Buildings/Resources/Documentation/userGuide
make html
make linkcheck
make copytowww

  8. On the release branch, regenerate the help files from Dymola.

  9. Run

    ../bin/cleanHTML.py

    and commit the new files.

  10. Run the script makeRelease.py with arguments such as

    makeRelease.py --version 1.0 --build 1

  11. Copy the files to the web server using the script postBuildingsTagToSrg.sh.

  12. Update http://simulationresearch.lbl.gov/modelica/Download.

  13. Update the web link using

    cd /usr/local/www/simulationresearch/modelica/releases
rm latest
ln -s vX.Y+build.Z latest

  14. Prepare next development version by:

    1. Adding a new ReleaseNotes package to Buildings/package.mo. Use this template.
    2. Update in Buildings/package.mo the section 
      annotation (
version="1.1",
versionBuild=0,
versionDate="2011-11-04",
dateModified="2011-12-07",
uses(Modelica(version="3.2")),
    3. Update in the same file 
      annotation (Documentation(info="<html>
 <p>
 This section summarizes the changes that have been performed
 on the Buildings library.
 </p>
 <p>
 <ul>
 <li> 
 <a href="modelica://Buildings.UsersGuide.ReleaseNotes.Version_1_4_build1">
 Version 1.4 build1</a>(xxx, 2013)</li>
 </li>

  15. To change back to the master branch, type

    git checkout master

User Guide

To update only the user guide, proceed as follows:

  1. Type 
    git checkout master
git pull
cd Buildings/Resources/Documentation/userGuide
  2. Either type 
    make dist
    or 
    make html
make linkcheck
make copytowww
    The second form can be used if make linkcheck reports broken links because links point to http://simulationresearch.lbl.gov/modelica/releases/latest/help and hence files that were added to the current release may not yet be posted under latest.
Add a custom footer
Add a custom sidebar
Clone this wiki locally