diff options
| author | sudoforge <no-reply@sudoforge.com> | 2025-05-23 10:07:38 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-05-23 10:07:38 -0700 |
| commit | e49c93d403afd662eeb3579f9a42ac45e75b7bef (patch) | |
| tree | 7826a4bcb1395127f968dd52618670604c4742b2 /doc/md/git-bug_version.md | |
| parent | 01d6899fd914b38aad34ee62ac9c620a06260306 (diff) | |
| download | git-bug-e49c93d403afd662eeb3579f9a42ac45e75b7bef.tar.gz git-bug-e49c93d403afd662eeb3579f9a42ac45e75b7bef.zip | |
build: reduce complexity for setting the version (#1466)
This change refactors the implementation of how the version is embedded
in the binary to reduce the number of variables necessary to determine
the version information from 3 to 1.
The legacy build variables are still supported, however, a warning will
be emitted instructing users to contact their package maintainer. The
legacy GitExacTag variable, if present, will be used to set main.version
if it is undefined. This ensures that unmigrated package builds will
continue to provide the correct version information.
The legacy build variables will be supported until 0.12.0, giving
package maintainers some time to migrate.
Change-Id: I05fea97169ea1af87b198174afe5b6663f860fd8
Diffstat (limited to 'doc/md/git-bug_version.md')
| -rw-r--r-- | doc/md/git-bug_version.md | 38 |
1 files changed, 33 insertions, 5 deletions
diff --git a/doc/md/git-bug_version.md b/doc/md/git-bug_version.md index ceba8790f..a2569aff1 100644 --- a/doc/md/git-bug_version.md +++ b/doc/md/git-bug_version.md @@ -1,18 +1,46 @@ ## git-bug version -Show git-bug version information +Print version information + +### Synopsis + + +Print version information. + +Format: + git-bug <version> [commit[/dirty]] <compiler version> <platform> <arch> + +Format Description: + <version> may be one of: + - A semantic version string, prefixed with a "v", e.g. v1.2.3 + - "undefined" (if not provided, or built with an invalid version string) + + [commit], if present, is the commit hash that was checked out during the + build. This may be suffixed with '/dirty' if there were local file + modifications. This is indicative of your build being patched, or modified in + some way from the commit. + + <compiler version> is the version of the go compiler used for the build. + + <platform> is the target platform (GOOS). + + <arch> is the target architecture (GOARCH). + ``` git-bug version [flags] ``` +### Examples + +``` +git bug version +``` + ### Options ``` - -n, --number Only show the version number - -c, --commit Only show the commit hash - -a, --all Show all version information - -h, --help help for version + -h, --help help for version ``` ### SEE ALSO |