1DUNAMAI(1)                       User Commands                      DUNAMAI(1)
2
3
4

NAME

6       dunamai - dunamai from fossil
7

DESCRIPTION

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