-
Notifications
You must be signed in to change notification settings - Fork 0
Release Version
Making a new release requires administrator permission.
To make a release of the Modelica library, proceed as follows:
-
Merge all changes to the
release
branch. -
On the
release
branch, update the first lines in the fileBuildings/package.mo
, such asannotation ( 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 whenversion
changes. A newversionBuild
does not changeversionDate
, but it does updatedateModified
in the format above, which can be processed by Modelica tools. -
On the
release
branch, changeREADME.md
to update the lineDownload [Buildings Library 1.4 build 1 (2013-01-31)](https://github.com/lbl-srg/modelica-buildings/archive/v1.4+build.1.zip)
-
Make sure that the conversion script, such as
ConvertModelica_from_0.12.0_to_0.13.mos
, contains all update commands. -
Run the script
bin/checkRelease.py
to check for invalid syntax. -
Run the unit tests.
-
Update the user guide by typing
cd Buildings/Resources/Documentation/userGuide make html make linkcheck make copytowww
-
On the
release
branch, regenerate thehelp
files from Dymola. -
Run
../bin/cleanHTML.py
and commit the new files.
-
Run the script
makeRelease.py
with arguments such asmakeRelease.py --version 1.0 --build 1
-
Copy the files to the web server using the script
postBuildingsTagToSrg.sh
. -
Update the web link using
cd /usr/local/www/simulationresearch/modelica/releases rm latest ln -s vX.Y+build.Z latest
-
Prepare next development version by:
- Adding a new
ReleaseNotes
package toBuildings/package.mo
. Use this template. - Update in
Buildings/package.mo
the sectionannotation ( version="1.1", versionBuild=0, versionDate="2011-11-04", dateModified="2011-12-07", uses(Modelica(version="3.2")),
- 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>
- Adding a new
-
To change back to the
master
branch, typegit checkout master
To update only the user guide, proceed as follows:
- Type
git checkout master git pull cd Buildings/Resources/Documentation/userGuide
- Either type
or
make dist
The second form can be used ifmake html make linkcheck make copytowww
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 underlatest
.