1DUNAMAI-FROM-MERCURIAL(1) User Commands DUNAMAI-FROM-MERCURIAL(1)
2
3
4
6 dunamai from mercurial – generate version from Mercurial
7
9 dunamai from mercurial [-h] [--metadata] [--no-metadata] [--dirty]
10 [--tagged-metadata] [--pattern PATTERN] [--format FORMAT]
11 [--style {pep440,semver,pvp}] [--latest-tag] [--strict] [--debug]
12 [--bump] [--full-commit]
13
15 OPTIONAL ARGUMENTS
16 -h, --help
17 Show a help message and exit
18
19 --metadata
20 Always include metadata. Ignored when --format is used (de‐
21 fault: None)
22
23 --no-metadata
24 Never include metadata. Ignored when --format is used (default:
25 None)
26
27 --dirty
28 Include dirty flag if applicable. Ignored when --format is used
29 (default: False)
30
31 --tagged-metadata
32 Include tagged metadata if applicable. Ignored when --format is
33 used (default: False)
34
35 --pattern PATTERN
36 Regular expression matched against the version source. This
37 must contain one capture group named base corresponding to the
38 release segment of the source. Optionally, it may contain an‐
39 other two groups named stage and revision corresponding to a
40 prerelease type (such as ‘alpha’ or ‘rc’) and number (such as in
41 ‘alpha-2’ or ‘rc3’). It may also contain a group named
42 tagged_metadata corresponding to extra metadata after the main
43 part of the version (typically after a plus sign). There may
44 also be a group named epoch for the PEP 440 concept. If the
45 base group is not present, then instead this will be interpreted
46 as a named preset, which may be one of the following: default,
47 default-unprefixed (default: (?x) (?# ignore whitespace)
48 ^v((?P<epoch>\d+)!)?(?P<base>\d+(\.\d+)*) (?# v1.2.3 or
49 v1!2000.1.2) ([-._]?((?P<stage>[a-zA-Z]+)[- ._]?(?P<revi‐
50 sion>\d+)?))? (?# b0) (\+(?P<tagged_metadata>.+))?$ (?# +linux))
51
52 --format FORMAT
53 Custom output format. Available substitutions: {base}, {stage},
54 {revision}, {distance}, {commit}, {dirty}, {tagged_metadata},
55 {epoch}, {branch}, {branch_escaped}, {timestamp} (default: None)
56
57 --style { pep440 , semver , pvp }
58 Preconfigured output format. Will default to PEP 440 if not set
59 and no custom format given. If you specify both a style and a
60 custom format, then the format will be validated against the
61 style’s rules (default: None)
62
63 --latest-tag
64 Only inspect the latest tag on the latest tagged commit for a
65 pattern match (default: False)
66
67 --strict
68 When there are no tags, fail instead of falling back to 0.0.0
69 (default: False)
70
71 --debug
72 Display additional information on stderr for troubleshooting
73 (default: False)
74
75 --bump Increment the last part of the version base by 1, unless the
76 stage is set, in which case increment the revision by 1 or set
77 it to a default of 2 if there was no revision. Does nothing
78 when on a commit with a version tag. (default: False)
79
80 --full-commit
81 Get the full commit hash instead of the short form (only: Git,
82 Mercurial) (default: False)
83
85 dunamai-from-any(1), dunamai-from-bazaar(1), dunamai-from-darcs(1),
86 dunamai-from-fossil(1), dunamai-from-git(1), dunamai-from-pijul(1),
87 dunamai-from-subversion(1)
88
89 dunamai-from(1), dunamai(1)
90
91 hg(1)
92
93
94
95 December 2022 DUNAMAI-FROM-MERCURIAL(1)