version_extractors

A version extractor produces the version string stamped into the built package. At least one is required. release and build select one with --version-extractor <name>; the first entry is the default.

Providers

file

Reads a file and applies a regex to extract the version.

version_extractors:
  - name: version_file
    provider: file
    file:
      file: VERSION
      regex: '^(.+)$'

shell

Runs a shell command; stdout (trimmed) is the version.

version_extractors:
  - name: git_tag
    provider: shell
    shell:
      command: "git describe --tags --abbrev=0"

constant

Hardcoded version string.

version_extractors:
  - name: fixed
    provider: constant
    constant:
      version: "1.0.0"

Failure behavior

An extractor failure stops the command. file fails when the file cannot be read or the regex is invalid or does not match; the regex runs over the whole file, and the version is capture group 1 of the first match. shell runs via sh -c in the project directory and fails on a nonzero exit.