README

   1 This is service repository that contains different maintenance utilities for
   2 SALOME project.
   3
   4 1) Versioning SALOME stable builds.
   5
   6 Each SALOME development build queue is serialized by dumping versioning
   7 information into dedicated files. Each such file has the following structure:
   8
   9 -----> start of the file
  10 # Comment lines start with '#' symbol.
  11 [SALOME]
  12 <module> = <git commit id>
  13 ...
  14
  15 [PRODUCTS]
  16 <product> = <version info>
  17 ...
  18 -----> end of the file
  19
  20 Here,
  21 - <module> is a name of SALOME module (plugin, tool);
  22 - <git commit id> is a corresponding git repository commit hash;
  23 - <product> is a (symbolic) name of the pre-requisite (e.g. "qt", "python");
  24 - <version info> is a version information for the product.
  25
  26 Each development build queue is dumped into a separate file; name of the file
  27 contains the information about the build queue. For example:
  28 - series7x_occt_stable : build SALOME series 7x (from master branch)
  29   with stable version of OCCT;
  30 - series7x_occt_dev : build SALOME series 7x (from master branch)
  31   with dev version of OCCT.
  32
  33 Notes:
  34 - The script that creates versioning file obtains an information about the
  35   pre-requisite products from the environment variables. Since there are no
  36   dedicated environment variables for some secondary products (like jinja2,
  37   pygments, docutils, etc), not all products info is available in the file.
  38 - For OCCT development version, the OCCT Git tag is used as version information.