classVersionManagement

Information

Version management

The ThermofluidStream library uses semantic versioning following the convention:

MAJOR.MINOR.PATCH

• MAJOR versions may contain incompatible changes that require users to adapt existing models.
• MINOR versions may add new models, packages, parameters or functionality in a generally backward compatible way.
• PATCH versions contain bug fixes, documentation updates and small maintenance changes.

For each release, the version information in the top-level package annotation should be updated, especially version, versionDate, dateModified and, if used, revisionId.

annotation(version      = "1.4.0",
           versionDate  = "YYYY-MM-DD",
           dateModified = "YYYY-MM-DD",
           revisionId   = "$F​ormat:%h %ci$")

The revisionId field is intended to identify the exact commit that the released version represents when the library is exported from a Git tag.

Recommended release procedure

1. Update the release notes.
2. Update the top-level package annotation to the new version.
3. Update tool-specific metadata, for example Dymola or Modelon Impact metadata, if present.
4. Run the regression tests and tool checks.
5. Create and push the Git tag, for example v1.4.0.
6. Create the GitHub release from the tag.