Skip to content

Commit

Permalink
Release v1.22.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@mtkennerly
mtkennerly committed Aug 7, 2024
1 parent af5370b commit d6a0e3f
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Unreleased
## v1.22.0 (2024-08-07)

* Fixed: The `--ignore-untracked` CLI flag was ignored.
* Added: `--commit-length` option.
Expand Down
52 changes: 47 additions & 5 deletions docs/dunamai.1
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH DUNAMAI "1" "2024\-07\-26" "dunamai 1.21.2" "Dunamai"
.TH DUNAMAI "1" "2024\-08\-07" "dunamai 1.22.0" "Dunamai"
.SH NAME
dunamai
.SH SYNOPSIS
Expand Down Expand Up @@ -26,8 +26,9 @@ usage: dunamai from any [\-h] [\-\-metadata] [\-\-no\-metadata] [\-\-dirty]
[\-\-pattern PATTERN] [\-\-pattern\-prefix PATTERN_PREFIX]
[\-\-format FORMAT] [\-\-style {pep440,semver,pvp}]
[\-\-latest\-tag] [\-\-strict] [\-\-path PATH] [\-\-debug]
[\-\-bump] [\-\-full\-commit] [\-\-tag\-branch TAG_BRANCH]
[\-\-tag\-dir TAG_DIR]
[\-\-bump] [\-\-full\-commit]
[\-\-commit\-length COMMIT_LENGTH]
[\-\-tag\-branch TAG_BRANCH] [\-\-tag\-dir TAG_DIR]

Generate version from any detected VCS

Expand Down Expand Up @@ -110,6 +111,10 @@ there was no `revision` Does nothing when on a commit with a version tag.
\fB\-\-full\-commit\fR
Get the full commit hash instead of the short form (only: Git, Mercurial)

.TP
\fB\-\-commit\-length\fR \fI\,COMMIT_LENGTH\/\fR
Use this many characters from the start of the full commit hash

.TP
\fB\-\-tag\-branch\fR \fI\,TAG_BRANCH\/\fR
Branch on which to find tags, if different than the current branch (only: Git)
Expand All @@ -127,7 +132,9 @@ usage: dunamai from git [\-h] [\-\-metadata] [\-\-no\-metadata] [\-\-dirty]
[\-\-pattern PATTERN] [\-\-pattern\-prefix PATTERN_PREFIX]
[\-\-format FORMAT] [\-\-style {pep440,semver,pvp}]
[\-\-latest\-tag] [\-\-strict] [\-\-path PATH] [\-\-debug]
[\-\-bump] [\-\-full\-commit] [\-\-tag\-branch TAG_BRANCH]
[\-\-bump] [\-\-full\-commit]
[\-\-commit\-length COMMIT_LENGTH]
[\-\-tag\-branch TAG_BRANCH]

Generate version from Git

Expand Down Expand Up @@ -210,6 +217,10 @@ there was no `revision` Does nothing when on a commit with a version tag.
\fB\-\-full\-commit\fR
Get the full commit hash instead of the short form (only: Git, Mercurial)

.TP
\fB\-\-commit\-length\fR \fI\,COMMIT_LENGTH\/\fR
Use this many characters from the start of the full commit hash

.TP
\fB\-\-tag\-branch\fR \fI\,TAG_BRANCH\/\fR
Branch on which to find tags, if different than the current branch (only: Git)
Expand All @@ -224,6 +235,7 @@ usage: dunamai from mercurial [\-h] [\-\-metadata] [\-\-no\-metadata] [\-\-dirty
[\-\-format FORMAT] [\-\-style {pep440,semver,pvp}]
[\-\-latest\-tag] [\-\-strict] [\-\-path PATH]
[\-\-debug] [\-\-bump] [\-\-full\-commit]
[\-\-commit\-length COMMIT_LENGTH]

Generate version from Mercurial

Expand Down Expand Up @@ -300,6 +312,10 @@ there was no `revision` Does nothing when on a commit with a version tag.
.TP
\fB\-\-full\-commit\fR
Get the full commit hash instead of the short form (only: Git, Mercurial)

.TP
\fB\-\-commit\-length\fR \fI\,COMMIT_LENGTH\/\fR
Use this many characters from the start of the full commit hash
.RE

.SS \fBdunamai from darcs\fR
Expand All @@ -310,6 +326,7 @@ usage: dunamai from darcs [\-h] [\-\-metadata] [\-\-no\-metadata] [\-\-dirty]
[\-\-pattern\-prefix PATTERN_PREFIX] [\-\-format FORMAT]
[\-\-style {pep440,semver,pvp}] [\-\-latest\-tag]
[\-\-strict] [\-\-path PATH] [\-\-debug] [\-\-bump]
[\-\-commit\-length COMMIT_LENGTH]

Generate version from Darcs

Expand Down Expand Up @@ -382,6 +399,10 @@ Display additional information on stderr for troubleshooting
Increment the last part of the version `base` by 1, unless the `stage` is set,
in which case increment the `revision` by 1 or set it to a default of 2 if
there was no `revision` Does nothing when on a commit with a version tag.

.TP
\fB\-\-commit\-length\fR \fI\,COMMIT_LENGTH\/\fR
Use this many characters from the start of the full commit hash
.RE

.SS \fBdunamai from subversion\fR
Expand All @@ -392,7 +413,9 @@ usage: dunamai from subversion [\-h] [\-\-metadata] [\-\-no\-metadata] [\-\-dirt
[\-\-pattern\-prefix PATTERN_PREFIX]
[\-\-format FORMAT] [\-\-style {pep440,semver,pvp}]
[\-\-latest\-tag] [\-\-strict] [\-\-path PATH]
[\-\-debug] [\-\-bump] [\-\-tag\-dir TAG_DIR]
[\-\-debug] [\-\-bump]
[\-\-commit\-length COMMIT_LENGTH]
[\-\-tag\-dir TAG_DIR]

Generate version from Subversion

Expand Down Expand Up @@ -466,6 +489,10 @@ Increment the last part of the version `base` by 1, unless the `stage` is set,
in which case increment the `revision` by 1 or set it to a default of 2 if
there was no `revision` Does nothing when on a commit with a version tag.

.TP
\fB\-\-commit\-length\fR \fI\,COMMIT_LENGTH\/\fR
Use this many characters from the start of the full commit hash

.TP
\fB\-\-tag\-dir\fR \fI\,TAG_DIR\/\fR
Location of tags relative to the root (only: Subversion)
Expand All @@ -479,6 +506,7 @@ usage: dunamai from bazaar [\-h] [\-\-metadata] [\-\-no\-metadata] [\-\-dirty]
[\-\-pattern\-prefix PATTERN_PREFIX] [\-\-format FORMAT]
[\-\-style {pep440,semver,pvp}] [\-\-latest\-tag]
[\-\-strict] [\-\-path PATH] [\-\-debug] [\-\-bump]
[\-\-commit\-length COMMIT_LENGTH]

Generate version from Bazaar

Expand Down Expand Up @@ -551,6 +579,10 @@ Display additional information on stderr for troubleshooting
Increment the last part of the version `base` by 1, unless the `stage` is set,
in which case increment the `revision` by 1 or set it to a default of 2 if
there was no `revision` Does nothing when on a commit with a version tag.

.TP
\fB\-\-commit\-length\fR \fI\,COMMIT_LENGTH\/\fR
Use this many characters from the start of the full commit hash
.RE

.SS \fBdunamai from fossil\fR
Expand All @@ -561,6 +593,7 @@ usage: dunamai from fossil [\-h] [\-\-metadata] [\-\-no\-metadata] [\-\-dirty]
[\-\-pattern\-prefix PATTERN_PREFIX] [\-\-format FORMAT]
[\-\-style {pep440,semver,pvp}] [\-\-latest\-tag]
[\-\-strict] [\-\-path PATH] [\-\-debug] [\-\-bump]
[\-\-commit\-length COMMIT_LENGTH]

Generate version from Fossil

Expand Down Expand Up @@ -633,6 +666,10 @@ Display additional information on stderr for troubleshooting
Increment the last part of the version `base` by 1, unless the `stage` is set,
in which case increment the `revision` by 1 or set it to a default of 2 if
there was no `revision` Does nothing when on a commit with a version tag.

.TP
\fB\-\-commit\-length\fR \fI\,COMMIT_LENGTH\/\fR
Use this many characters from the start of the full commit hash
.RE

.SS \fBdunamai from pijul\fR
Expand All @@ -643,6 +680,7 @@ usage: dunamai from pijul [\-h] [\-\-metadata] [\-\-no\-metadata] [\-\-dirty]
[\-\-pattern\-prefix PATTERN_PREFIX] [\-\-format FORMAT]
[\-\-style {pep440,semver,pvp}] [\-\-latest\-tag]
[\-\-strict] [\-\-path PATH] [\-\-debug] [\-\-bump]
[\-\-commit\-length COMMIT_LENGTH]

Generate version from Pijul

Expand Down Expand Up @@ -715,6 +753,10 @@ Display additional information on stderr for troubleshooting
Increment the last part of the version `base` by 1, unless the `stage` is set,
in which case increment the `revision` by 1 or set it to a default of 2 if
there was no `revision` Does nothing when on a commit with a version tag.

.TP
\fB\-\-commit\-length\fR \fI\,COMMIT_LENGTH\/\fR
Use this many characters from the start of the full commit hash
.RE

.SS \fBdunamai check\fR
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "dunamai"
version = "1.21.2"
version = "1.22.0"
description = "Dynamic version generation"
license = "MIT"
authors = ["Matthew T. Kennerly <[email protected]>"]
Expand Down

0 comments on commit d6a0e3f

Please sign in to comment.