serv/caddy
1
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2024-12-27 06:03:48 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

core: Set version manually via CustomVersion (#5072)

Browse source 
* Allow version to be set manually

When Caddy is built from a release tarball (as downloaded from GitHub),
`caddy version` returns an empty string. This causes confusion for
downstream packagers.

With this commit, VersionString can be set with eg.
  go build (...) -ldflags '-X (...).VersionString=v1.2.3'
Then the short form version will be "v1.2.3", and the full version
string will begin with "v1.2.3 ".

* Prefer embedded version, then CustomVersion

* Prefer "unknown" for full version over empty

Co-authored-by: Matthew Holt <mholt@users.noreply.github.com>
This commit is contained in:
Adam Weinberger 2022-10-05 10:59:57 -06:00 committed by GitHub
parent 2153a81ec8
commit e4fac1294f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
caddy.go
View file

@ -824,6 +824,20 @@ func InstanceID() (uuid.UUID, error) {
return uuid.ParseBytes(uuidFileBytes) return uuid.ParseBytes(uuidFileBytes)
} }
// CustomVersion is an optional string that overrides Caddy's
// reported version. It can be helpful when downstream packagers
// need to manually set Caddy's version. If no other version
// information is available, the short form version (see
// Version()) will be set to CustomVersion, and the full version
// will include CustomVersion at the beginning.
//
// Set this variable during `go build` with `-ldflags`:
//
// -ldflags '-X github.com/caddyserver/caddy/v2.CustomVersion=v2.6.2'
//
// for example.
var CustomVersion string
// Version returns the Caddy version in a simple/short form, and // Version returns the Caddy version in a simple/short form, and
// a full version string. The short form will not have spaces and // a full version string. The short form will not have spaces and
// is intended for User-Agent strings and similar, but may be // is intended for User-Agent strings and similar, but may be
@ -833,8 +847,10 @@ func InstanceID() (uuid.UUID, error) {
// build info provided by go.mod dependencies; then it tries to // build info provided by go.mod dependencies; then it tries to
// get info from embedded VCS information, which requires having // get info from embedded VCS information, which requires having
// built Caddy from a git repository. If no version is available, // built Caddy from a git repository. If no version is available,
// this function returns "(devel)" becaise Go uses that, but for // this function returns "(devel)" because Go uses that, but for
// the simple form we change it to "unknown". // the simple form we change it to "unknown". If still no version
// is available (e.g. no VCS repo), then it will use CustomVersion;
// CustomVersion is always prepended to the full version string.
// //
// See relevant Go issues: https://github.com/golang/go/issues/29228 // See relevant Go issues: https://github.com/golang/go/issues/29228
// and https://github.com/golang/go/issues/50603. // and https://github.com/golang/go/issues/50603.
@ -910,9 +926,23 @@ func Version() (simple, full string) {
} }
} }
if full == "" {
if CustomVersion != "" {
full = CustomVersion
} else {
full = "unknown"
}
} else if CustomVersion != "" {
full = CustomVersion + " " + full
}
if simple == "" || simple == "(devel)" { if simple == "" || simple == "(devel)" {
if CustomVersion != "" {
simple = CustomVersion
} else {
simple = "unknown" simple = "unknown"
} }
}
return return
} }