Package: vm
Updates versions across multiple files.Installpip install vmUsageYou need aversions.json, or aversions.ymlwhere you can specify
for what you’re tracking the versions, and what files to be updated
using glob patterns:germanium:
  version: 1.10.3
  files:
    README.*: "^(germanium )(.*?)$"
    setup.py: "version='**VERSION**',"
    doc/usage/index.adoc: "^(= Germanium v)(.*?)$"
    germanium/version.py: "current = \"**VERSION**\""Help:usage: version-manager [-h] [--display NAME] [--all]
                       [--set NAME=VAL [NAME=VAL ...]] [--load FILE] [-t]
                       [--ignore-missing-parents] [--version]

Versions processor

optional arguments:
  -h, --help            show this help message and exit
  --display NAME, -d NAME
                        Display the version of a single tracked version.
  --all, -a, --list     Display all the tracked versions and their values.
  --set NAME=VAL [NAME=VAL ...], -s NAME=VAL [NAME=VAL ...]
                        Set values overriding what's in the yml files.
  --load FILE, -l FILE  Override versions from the given yml file.
  -t, --tag-name, --tag
                        Get the current name to use in general tags. If the
                        branch name can't be detected from the git repo, the
                        $BRANCH_NAME environment variable will be used.
  --ignore-missing-parents
                        Ignore missing parents, and simply don't patch the
                        values. Upstream values are still being patched if
                        existing.
  --version             Show the currently installed program version (2.5.1)Specifying VersionsThe version value will be expanded using the shell if it contains a '$'
or a '’, so you can have a version such as:"description": {
  "version": "Built at $(date) on $(uname -n)"
}or YAML:description:
  version: Built at $(date) on $(uname -n)Versions can also refer to other version files, and extract properties
from there, using theparent:notation in the version:"germaniumdrivers": {
  "version": "parent:../germanium/@germaniumdrivers"
}

germaniumdrivers:
  version: "parent:../germanium/@germaniumdrivers"The path will point to theversions.json/ymlfile, or to the folder
that contains theversions.json/ymlfile, and after that fill will be
read and interpreted thegermaniumdriversversion will be used.Versions can be also manually overriden from the command line, using the--setor-sflag, for example:version-manager -s germanium=2.0.8This will ignore the value specified in the versions.yml file, and use
the specified one.Feature BranchesThe version can also be prefixed byupstream:. In that case if the
currently checked out branch name contains-x-, or the exported
BRANCH_NAME environment variable has that name, the version returned byversion-manager --tagwill be used instead.germaniumdrivers:
  version: "upstream:1.1.0"As long as the branch is not marked to contain cross feature branches
dependencies with-x-it will return1.1.0.This also works for parent branches, so you can have:germaniumdrivers:
  version: "parent:upstream:../germanium/@germaniumdrivers"If the branch name is for example:feature/UI-123-x-test-new-driverstheparent:value will not be read, and0.1-feature_UI-123-x-test-new-driverswill be returned as the value.File MatchersThere are currently only three file matchers:RegExp File MatcherIt is a RegExp that has two or three groups, and it will have the second
group replaced to the matched version.VERSIONFile MatcherThis will construct a RegExp that will match exactly the given text,
with theVERSIONbeing the second group.So having a matcher such as:"files": {
    "README": "This installs version **VERSION** of the product."
}or yamlfiles:
  README: This installs version **VERSION** of the product.is equivalent with:"files": {
    "README": "(This installs version )(.+?)( of the product\\.)"
}or yamlfiles:
  README: (This installs version )(.+?)( of the product\\.)If the**`s are replaced with `^^at the beginning, or` at the end, they will act as RegExp anchors, equivalent to `^` and `$`. In case in the expression there is content before the `^^`, or after the `, the
content is ignored.maven: File MatcherThis will construct a RegExp that will match:`(<groupId>${m[1]}</groupId>\\s*` +
`<artifactId>${m[2]}</artifactId>\\s*` +
`<version>)(.*?)(</version>)`;In order to specify the matcher, just use:{"germanium": {
  "version": "2.0.0",
  "files": {
    "pom.xml": "maven:com.germaniumhq:germanium"
  }
}or yamlgermanium:
  version: 2.0.0
  files:
    pom.xml: maven:com.germaniumhq:germaniumMatcher ConstraintsIn order to make sure that the expressions are not replacing in too many
places, constraints can be added to limit, or extend the matches.Matcher constraints are always active, and in case no constraint is
specified then the maximum replacement count is set to 1.Match Count{
  "product" : {
    "version": "1.0",
    "files": {
      "README.md": {
        "match": "^(= Germanium v)(.*?)$",
        "count": 2
      }
    }
  }
}or yamlproduct:
  version: "1.0"
  files:
    README.md:
      match: ^(= Germanium v)(.*?)$
      count: 2The count can be also0for no matches, or negative to indicate any
number of matches is allowed.Multiple MatchersIn a single file, we can have multiple matchers as well, for example:{
  "product" : {
    "version": "1.0",
    "files": {
      "README.md": [
        "^(= Germanium v)(.*?)$",
        "(Germanium )(\\d+\\.\\d+)()"
      ]
    }
  }
}For each matcher that is added, if there is no match count specified,
it’s assumed that it will only match once in the file.Of course, constraints can be applied for both the full set of matchers:{
  "product" : {
    "version": "1.0",
    "files": {
      "README.md": {
        "match": [
          "^(= Germanium v)(.*?)$",
          "(Germanium )(\\d+\\.\\d+)()"
        ],
        "count": 3
      }
    }
  }
}or even individual expressions:{
  "product" : {
    "version": "1.0",
    "files": {
      "README.md": {
        "match": [
          "^(= Germanium v)(.*?)$",
          {
            "match": "(Germanium )(\\d+\\.\\d+)()",
            "count": 2
          }
        ],
        "count": 3
      }
    }
  }
}NotesFiles are actuallyglobpatterns, so you can match*/.jsfor
example.The configuration files can be yml.vmwill output the following error codes: 0 when no files are
changed, 0 when files are changed successfuly, or a non zero error
code in case of error.