Infrastructure/caddy
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2024-12-23 22:27:38 -05:00
Code Issues Activity
caddy/build.bash

56 lines
1.2 KiB
Bash
Raw Normal View History

Implant version information with -ldflags with help of build script Without -ldflags, the verison information needs to be updated manually, which is never done between releases, so development builds appear indiscernable from stable builds using `caddy -version`. This is part of a set of changes intended to relieve the burden of always updating version information manually and distributing binaries that look stable but actually may not be. A stable build is defined as one which is produced at a git tag with a clean working directory (no uncommitted changes). A dev build is anything else. With this build script, `caddy -version` will now reveal whether it is a development build and, if so, the base version, the latest commit, the date and time of build, and the names of files with changes as well as how many changes were made. The output of `caddy -version` for stable builds remains the same.
2016-02-26 02:21:20 -05:00
#!/usr/bin/env bash
#
# Caddy build script. Automates proper versioning.
#
# Usage:
#
# $ ./build.bash [output_filename]
#
# Outputs compiled program in current directory.
# Default file name is 'ecaddy'.
Use best practices in build.bash Format of main.buildDate has been locale-dependent, and is now ISO-8601 compliant. Caddy displayed with ```-version``` something like (mind the datetime format): Caddy 0.8.2 (+591b209 Fri Mar 18 21:22:55 UTC 2016) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash main.go which is now: Caddy 0.8.2 (+591b209 2016-03-18 21:22:55Z) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash,main.go See also: * http://wiki.bash-hackers.org/scripting/obsolete * https://google.github.io/styleguide/shell.xml * https://xkcd.com/1179/
2016-03-18 17:10:24 -05:00
Convert the barbarism in dist/automate.sh to proper BASH structure When thy variables henceforth accept blessed white-space, guided will thy scripture be along righteous path(s). -- 4 BASH 3:42 Caddy's dist files sometimes ended up being owned by matt:staff or other quite arcane and/or frightening names. If someone extracting didn't pay attention a regular user who happened to have same uid by accident could later tamper with the files' contents. It's 0:0 from now on. Use all available threads when packaging distributables Caddy binaries will be added to their archives in-place: This change eliminates them being renamed within dist/builds one after another. As does 'gox', dist/automate.sh will spare one available thread if possible.
2016-03-18 17:45:56 -05:00
set -euo pipefail
Implant version information with -ldflags with help of build script Without -ldflags, the verison information needs to be updated manually, which is never done between releases, so development builds appear indiscernable from stable builds using `caddy -version`. This is part of a set of changes intended to relieve the burden of always updating version information manually and distributing binaries that look stable but actually may not be. A stable build is defined as one which is produced at a git tag with a clean working directory (no uncommitted changes). A dev build is anything else. With this build script, `caddy -version` will now reveal whether it is a development build and, if so, the base version, the latest commit, the date and time of build, and the names of files with changes as well as how many changes were made. The output of `caddy -version` for stable builds remains the same.
2016-02-26 02:21:20 -05:00
Convert the barbarism in dist/automate.sh to proper BASH structure When thy variables henceforth accept blessed white-space, guided will thy scripture be along righteous path(s). -- 4 BASH 3:42 Caddy's dist files sometimes ended up being owned by matt:staff or other quite arcane and/or frightening names. If someone extracting didn't pay attention a regular user who happened to have same uid by accident could later tamper with the files' contents. It's 0:0 from now on. Use all available threads when packaging distributables Caddy binaries will be added to their archives in-place: This change eliminates them being renamed within dist/builds one after another. As does 'gox', dist/automate.sh will spare one available thread if possible.
2016-03-18 17:45:56 -05:00
: ${output_filename:="${1:-}"}
Use best practices in build.bash Format of main.buildDate has been locale-dependent, and is now ISO-8601 compliant. Caddy displayed with ```-version``` something like (mind the datetime format): Caddy 0.8.2 (+591b209 Fri Mar 18 21:22:55 UTC 2016) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash main.go which is now: Caddy 0.8.2 (+591b209 2016-03-18 21:22:55Z) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash,main.go See also: * http://wiki.bash-hackers.org/scripting/obsolete * https://google.github.io/styleguide/shell.xml * https://xkcd.com/1179/
2016-03-18 17:10:24 -05:00
: ${output_filename:="ecaddy"}
Implant version information with -ldflags with help of build script Without -ldflags, the verison information needs to be updated manually, which is never done between releases, so development builds appear indiscernable from stable builds using `caddy -version`. This is part of a set of changes intended to relieve the burden of always updating version information manually and distributing binaries that look stable but actually may not be. A stable build is defined as one which is produced at a git tag with a clean working directory (no uncommitted changes). A dev build is anything else. With this build script, `caddy -version` will now reveal whether it is a development build and, if so, the base version, the latest commit, the date and time of build, and the names of files with changes as well as how many changes were made. The output of `caddy -version` for stable builds remains the same.
2016-02-26 02:21:20 -05:00
pkg=main
Use best practices in build.bash Format of main.buildDate has been locale-dependent, and is now ISO-8601 compliant. Caddy displayed with ```-version``` something like (mind the datetime format): Caddy 0.8.2 (+591b209 Fri Mar 18 21:22:55 UTC 2016) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash main.go which is now: Caddy 0.8.2 (+591b209 2016-03-18 21:22:55Z) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash,main.go See also: * http://wiki.bash-hackers.org/scripting/obsolete * https://google.github.io/styleguide/shell.xml * https://xkcd.com/1179/
2016-03-18 17:10:24 -05:00
ldflags=()
Implant version information with -ldflags with help of build script Without -ldflags, the verison information needs to be updated manually, which is never done between releases, so development builds appear indiscernable from stable builds using `caddy -version`. This is part of a set of changes intended to relieve the burden of always updating version information manually and distributing binaries that look stable but actually may not be. A stable build is defined as one which is produced at a git tag with a clean working directory (no uncommitted changes). A dev build is anything else. With this build script, `caddy -version` will now reveal whether it is a development build and, if so, the base version, the latest commit, the date and time of build, and the names of files with changes as well as how many changes were made. The output of `caddy -version` for stable builds remains the same.
2016-02-26 02:21:20 -05:00
# Timestamp of build
Use best practices in build.bash Format of main.buildDate has been locale-dependent, and is now ISO-8601 compliant. Caddy displayed with ```-version``` something like (mind the datetime format): Caddy 0.8.2 (+591b209 Fri Mar 18 21:22:55 UTC 2016) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash main.go which is now: Caddy 0.8.2 (+591b209 2016-03-18 21:22:55Z) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash,main.go See also: * http://wiki.bash-hackers.org/scripting/obsolete * https://google.github.io/styleguide/shell.xml * https://xkcd.com/1179/
2016-03-18 17:10:24 -05:00
name="${pkg}.buildDate"
value=$(date --utc +"%F %H:%M:%SZ")
ldflags+=("-X" "\"${name}=${value}\"")
Implant version information with -ldflags with help of build script Without -ldflags, the verison information needs to be updated manually, which is never done between releases, so development builds appear indiscernable from stable builds using `caddy -version`. This is part of a set of changes intended to relieve the burden of always updating version information manually and distributing binaries that look stable but actually may not be. A stable build is defined as one which is produced at a git tag with a clean working directory (no uncommitted changes). A dev build is anything else. With this build script, `caddy -version` will now reveal whether it is a development build and, if so, the base version, the latest commit, the date and time of build, and the names of files with changes as well as how many changes were made. The output of `caddy -version` for stable builds remains the same.
2016-02-26 02:21:20 -05:00
# Current tag, if HEAD is on a tag
Use best practices in build.bash Format of main.buildDate has been locale-dependent, and is now ISO-8601 compliant. Caddy displayed with ```-version``` something like (mind the datetime format): Caddy 0.8.2 (+591b209 Fri Mar 18 21:22:55 UTC 2016) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash main.go which is now: Caddy 0.8.2 (+591b209 2016-03-18 21:22:55Z) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash,main.go See also: * http://wiki.bash-hackers.org/scripting/obsolete * https://google.github.io/styleguide/shell.xml * https://xkcd.com/1179/
2016-03-18 17:10:24 -05:00
name="${pkg}.gitTag"
Implant version information with -ldflags with help of build script Without -ldflags, the verison information needs to be updated manually, which is never done between releases, so development builds appear indiscernable from stable builds using `caddy -version`. This is part of a set of changes intended to relieve the burden of always updating version information manually and distributing binaries that look stable but actually may not be. A stable build is defined as one which is produced at a git tag with a clean working directory (no uncommitted changes). A dev build is anything else. With this build script, `caddy -version` will now reveal whether it is a development build and, if so, the base version, the latest commit, the date and time of build, and the names of files with changes as well as how many changes were made. The output of `caddy -version` for stable builds remains the same.
2016-02-26 02:21:20 -05:00
set +e
Use best practices in build.bash Format of main.buildDate has been locale-dependent, and is now ISO-8601 compliant. Caddy displayed with ```-version``` something like (mind the datetime format): Caddy 0.8.2 (+591b209 Fri Mar 18 21:22:55 UTC 2016) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash main.go which is now: Caddy 0.8.2 (+591b209 2016-03-18 21:22:55Z) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash,main.go See also: * http://wiki.bash-hackers.org/scripting/obsolete * https://google.github.io/styleguide/shell.xml * https://xkcd.com/1179/
2016-03-18 17:10:24 -05:00
value="$(git describe --exact-match HEAD 2>/dev/null)"
Implant version information with -ldflags with help of build script Without -ldflags, the verison information needs to be updated manually, which is never done between releases, so development builds appear indiscernable from stable builds using `caddy -version`. This is part of a set of changes intended to relieve the burden of always updating version information manually and distributing binaries that look stable but actually may not be. A stable build is defined as one which is produced at a git tag with a clean working directory (no uncommitted changes). A dev build is anything else. With this build script, `caddy -version` will now reveal whether it is a development build and, if so, the base version, the latest commit, the date and time of build, and the names of files with changes as well as how many changes were made. The output of `caddy -version` for stable builds remains the same.
2016-02-26 02:21:20 -05:00
set -e
Use best practices in build.bash Format of main.buildDate has been locale-dependent, and is now ISO-8601 compliant. Caddy displayed with ```-version``` something like (mind the datetime format): Caddy 0.8.2 (+591b209 Fri Mar 18 21:22:55 UTC 2016) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash main.go which is now: Caddy 0.8.2 (+591b209 2016-03-18 21:22:55Z) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash,main.go See also: * http://wiki.bash-hackers.org/scripting/obsolete * https://google.github.io/styleguide/shell.xml * https://xkcd.com/1179/
2016-03-18 17:10:24 -05:00
ldflags+=("-X" "\"${name}=${value}\"")
Implant version information with -ldflags with help of build script Without -ldflags, the verison information needs to be updated manually, which is never done between releases, so development builds appear indiscernable from stable builds using `caddy -version`. This is part of a set of changes intended to relieve the burden of always updating version information manually and distributing binaries that look stable but actually may not be. A stable build is defined as one which is produced at a git tag with a clean working directory (no uncommitted changes). A dev build is anything else. With this build script, `caddy -version` will now reveal whether it is a development build and, if so, the base version, the latest commit, the date and time of build, and the names of files with changes as well as how many changes were made. The output of `caddy -version` for stable builds remains the same.
2016-02-26 02:21:20 -05:00
# Nearest tag on branch
Use best practices in build.bash Format of main.buildDate has been locale-dependent, and is now ISO-8601 compliant. Caddy displayed with ```-version``` something like (mind the datetime format): Caddy 0.8.2 (+591b209 Fri Mar 18 21:22:55 UTC 2016) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash main.go which is now: Caddy 0.8.2 (+591b209 2016-03-18 21:22:55Z) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash,main.go See also: * http://wiki.bash-hackers.org/scripting/obsolete * https://google.github.io/styleguide/shell.xml * https://xkcd.com/1179/
2016-03-18 17:10:24 -05:00
name="${pkg}.gitNearestTag"
value="$(git describe --abbrev=0 --tags HEAD)"
ldflags+=("-X" "\"${name}=${value}\"")
Implant version information with -ldflags with help of build script Without -ldflags, the verison information needs to be updated manually, which is never done between releases, so development builds appear indiscernable from stable builds using `caddy -version`. This is part of a set of changes intended to relieve the burden of always updating version information manually and distributing binaries that look stable but actually may not be. A stable build is defined as one which is produced at a git tag with a clean working directory (no uncommitted changes). A dev build is anything else. With this build script, `caddy -version` will now reveal whether it is a development build and, if so, the base version, the latest commit, the date and time of build, and the names of files with changes as well as how many changes were made. The output of `caddy -version` for stable builds remains the same.
2016-02-26 02:21:20 -05:00
# Commit SHA
Use best practices in build.bash Format of main.buildDate has been locale-dependent, and is now ISO-8601 compliant. Caddy displayed with ```-version``` something like (mind the datetime format): Caddy 0.8.2 (+591b209 Fri Mar 18 21:22:55 UTC 2016) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash main.go which is now: Caddy 0.8.2 (+591b209 2016-03-18 21:22:55Z) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash,main.go See also: * http://wiki.bash-hackers.org/scripting/obsolete * https://google.github.io/styleguide/shell.xml * https://xkcd.com/1179/
2016-03-18 17:10:24 -05:00
name="${pkg}.gitCommit"
value="$(git rev-parse --short HEAD)"
ldflags+=("-X" "\"${name}=${value}\"")
Implant version information with -ldflags with help of build script Without -ldflags, the verison information needs to be updated manually, which is never done between releases, so development builds appear indiscernable from stable builds using `caddy -version`. This is part of a set of changes intended to relieve the burden of always updating version information manually and distributing binaries that look stable but actually may not be. A stable build is defined as one which is produced at a git tag with a clean working directory (no uncommitted changes). A dev build is anything else. With this build script, `caddy -version` will now reveal whether it is a development build and, if so, the base version, the latest commit, the date and time of build, and the names of files with changes as well as how many changes were made. The output of `caddy -version` for stable builds remains the same.
2016-02-26 02:21:20 -05:00
Use best practices in build.bash Format of main.buildDate has been locale-dependent, and is now ISO-8601 compliant. Caddy displayed with ```-version``` something like (mind the datetime format): Caddy 0.8.2 (+591b209 Fri Mar 18 21:22:55 UTC 2016) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash main.go which is now: Caddy 0.8.2 (+591b209 2016-03-18 21:22:55Z) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash,main.go See also: * http://wiki.bash-hackers.org/scripting/obsolete * https://google.github.io/styleguide/shell.xml * https://xkcd.com/1179/
2016-03-18 17:10:24 -05:00
# Summary of uncommitted changes
name="${pkg}.gitShortStat"
value="$(git diff-index --shortstat HEAD)"
ldflags+=("-X" "\"${name}=${value}\"")
Implant version information with -ldflags with help of build script Without -ldflags, the verison information needs to be updated manually, which is never done between releases, so development builds appear indiscernable from stable builds using `caddy -version`. This is part of a set of changes intended to relieve the burden of always updating version information manually and distributing binaries that look stable but actually may not be. A stable build is defined as one which is produced at a git tag with a clean working directory (no uncommitted changes). A dev build is anything else. With this build script, `caddy -version` will now reveal whether it is a development build and, if so, the base version, the latest commit, the date and time of build, and the names of files with changes as well as how many changes were made. The output of `caddy -version` for stable builds remains the same.
2016-02-26 02:21:20 -05:00
# List of modified files
Use best practices in build.bash Format of main.buildDate has been locale-dependent, and is now ISO-8601 compliant. Caddy displayed with ```-version``` something like (mind the datetime format): Caddy 0.8.2 (+591b209 Fri Mar 18 21:22:55 UTC 2016) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash main.go which is now: Caddy 0.8.2 (+591b209 2016-03-18 21:22:55Z) 2 files changed, 9 insertions(+), 4 deletions(-) build.bash,main.go See also: * http://wiki.bash-hackers.org/scripting/obsolete * https://google.github.io/styleguide/shell.xml * https://xkcd.com/1179/
2016-03-18 17:10:24 -05:00
name="${pkg}.gitFilesModified"
value="$(git diff-index --name-only HEAD | tr "\n" "," | sed -e 's:,$::')"
ldflags+=("-X" "\"${name}=${value}\"")
set -x
go build \
-ldflags "${ldflags[*]}" \
-o "${output_filename}"
Reference in a new issue Copy permalink