Merge pull request #416 from samalba/release-doc

Release doc
This commit is contained in:
Sam Alba 2021-05-04 11:40:29 -07:00 committed by GitHub
commit 7c7a6bc741
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 358 additions and 8 deletions

View File

@ -43,7 +43,10 @@ changelog:
filters:
exclude:
- '^docs:'
- '^doc:'
- '^test:'
- '^tests:'
- '^Merge pull request'
brews:
-

View File

@ -1,16 +1,53 @@
# Installing Dagger
1. Build the `dagger` command-line tool. You will need [Go](https://golang.org) version 1.16 or later.
## Option 1 (Mac OS only): install from Homebrew
```
$ make
From your Mac OS terminal, run the following command:
```shell
brew install dagger/tap/dagger
```
2. Copy the `dagger` tool to a location listed in your `$PATH`. For example, to copy it to `/usr/local/bin`:
## Option 2: install from a shell script
```
$ cp ./cmd/dagger/dagger /usr/local/bin
From a terminal, run the following command:
```shell
curl -sfL https://dagger-io.s3.amazonaws.com/dagger/install.sh | sh
```
3. Make sure your machine is running a buildkit daemon. If you have Docker installed, you're already good to go.
Otherwise, install either [Docker](https://www.docker.com/products/docker-desktop) or [buildkit](https://github.com/moby/buildkit#quick-start).
You now have the dagger binary in the local directory under `./bin/dagger`.
You can then install it globally on your system:
```shell
sudo mv ./bin/dagger /usr/local/bin
```
## Option 3: Manually fetch the latest binary release from Github
Open your web browser to [the latest release](https://github.com/dagger/dagger/releases/latest).
From the **assets** section, download the archive corresponding to your OS and Arch.
## Option 4: Compile from source
You will need [Go](https://golang.org) version 1.16 or later.
1. Clone the dagger repository
```shell
git clone https://github.com/dagger/dagger.git
```
2. Build the `dagger` binary.
```shell
cd dagger; make
```
3. Copy the `dagger` tool to a location listed in your `$PATH`. For example, to copy it to `/usr/local/bin`:
```shell
cp ./cmd/dagger/dagger /usr/local/bin
```

310
install.sh Executable file
View File

@ -0,0 +1,310 @@
#!/bin/sh
set -e
name="dagger"
base="https://dagger-io.s3.amazonaws.com"
cat /dev/null <<EOF
------------------------------------------------------------------------
https://github.com/client9/shlib - portable posix shell functions
Public domain - http://unlicense.org
https://github.com/client9/shlib/blob/master/LICENSE.md
but credit (and pull requests) appreciated.
------------------------------------------------------------------------
EOF
is_command() {
command -v "$1" >/dev/null
}
echoerr() {
echo "$@" 1>&2
}
log_prefix() {
echo "$0"
}
_logp=7
log_set_priority() {
_logp="$1"
}
log_priority() {
if test -z "$1"; then
echo "$_logp"
return
fi
[ "$1" -le "$_logp" ]
}
log_tag() {
case $1 in
0) echo "emerg" ;;
1) echo "alert" ;;
2) echo "crit" ;;
3) echo "err" ;;
4) echo "warning" ;;
5) echo "notice" ;;
6) echo "info" ;;
7) echo "debug" ;;
*) echo "$1" ;;
esac
}
log_debug() {
log_priority 7 || return 0
echoerr "$(log_prefix)" "$(log_tag 7)" "$@"
}
log_info() {
log_priority 6 || return 0
echoerr "$(log_prefix)" "$(log_tag 6)" "$@"
}
log_err() {
log_priority 3 || return 0
echoerr "$(log_prefix)" "$(log_tag 3)" "$@"
}
log_crit() {
log_priority 2 || return 0
echoerr "$(log_prefix)" "$(log_tag 2)" "$@"
}
uname_os() {
os=$(uname -s | tr '[:upper:]' '[:lower:]')
case "$os" in
cygwin_nt*) os="windows" ;;
mingw*) os="windows" ;;
msys_nt*) os="windows" ;;
esac
echo "$os"
}
uname_arch() {
arch=$(uname -m)
case $arch in
x86_64) arch="amd64" ;;
x86) arch="386" ;;
i686) arch="386" ;;
i386) arch="386" ;;
aarch64) arch="arm64" ;;
armv5*) arch="armv5" ;;
armv6*) arch="armv6" ;;
armv7*) arch="armv7" ;;
esac
echo ${arch}
}
uname_os_check() {
os=$(uname_os)
case "$os" in
darwin) return 0 ;;
dragonfly) return 0 ;;
freebsd) return 0 ;;
linux) return 0 ;;
android) return 0 ;;
nacl) return 0 ;;
netbsd) return 0 ;;
openbsd) return 0 ;;
plan9) return 0 ;;
solaris) return 0 ;;
windows) return 0 ;;
esac
log_crit "uname_os_check '$(uname -s)' got converted to '$os' which is not a GOOS value. Please file bug at https://github.com/client9/shlib"
return 1
}
uname_arch_check() {
arch=$(uname_arch)
case "$arch" in
386) return 0 ;;
amd64) return 0 ;;
arm64) return 0 ;;
armv5) return 0 ;;
armv6) return 0 ;;
armv7) return 0 ;;
ppc64) return 0 ;;
ppc64le) return 0 ;;
mips) return 0 ;;
mipsle) return 0 ;;
mips64) return 0 ;;
mips64le) return 0 ;;
s390x) return 0 ;;
amd64p32) return 0 ;;
esac
log_crit "uname_arch_check '$(uname -m)' got converted to '$arch' which is not a GOARCH value. Please file bug report at https://github.com/client9/shlib"
return 1
}
untar() {
tarball=$1
case "${tarball}" in
*.tar.gz | *.tgz) tar --no-same-owner -xzf "${tarball}" ;;
*.tar) tar --no-same-owner -xf "${tarball}" ;;
*.zip) unzip "${tarball}" ;;
*)
log_err "untar unknown archive format for ${tarball}"
return 1
;;
esac
}
http_download_curl() {
local_file=$1
source_url=$2
header=$3
if [ -z "$header" ]; then
code=$(curl -w '%{http_code}' -sL -o "$local_file" "$source_url")
else
code=$(curl -w '%{http_code}' -sL -H "$header" -o "$local_file" "$source_url")
fi
if [ "$code" != "200" ]; then
log_debug "http_download_curl received HTTP status $code"
return 1
fi
return 0
}
http_download_wget() {
local_file=$1
source_url=$2
header=$3
if [ -z "$header" ]; then
wget -q -O "$local_file" "$source_url"
else
wget -q --header "$header" -O "$local_file" "$source_url"
fi
}
http_download() {
log_debug "http_download $2"
if is_command curl; then
http_download_curl "$@"
return
elif is_command wget; then
http_download_wget "$@"
return
fi
log_crit "http_download unable to find wget or curl"
return 1
}
http_copy() {
tmp=$(mktemp)
http_download "${tmp}" "$1" "$2" || return 1
body=$(cat "$tmp")
rm -f "${tmp}"
echo "$body"
}
github_release() {
owner_repo=$1
version=$2
test -z "$version" && version="latest"
giturl="https://github.com/${owner_repo}/releases/${version}"
json=$(http_copy "$giturl" "Accept:application/json")
test -z "$json" && return 1
version=$(echo "$json" | tr -s '\n' ' ' | sed 's/.*"tag_name":"//' | sed 's/".*//')
test -z "$version" && return 1
echo "$version"
}
hash_sha256() {
TARGET=${1:-/dev/stdin}
if is_command gsha256sum; then
hash=$(gsha256sum "$TARGET") || return 1
echo "$hash" | cut -d ' ' -f 1
elif is_command sha256sum; then
hash=$(sha256sum "$TARGET") || return 1
echo "$hash" | cut -d ' ' -f 1
elif is_command shasum; then
hash=$(shasum -a 256 "$TARGET" 2>/dev/null) || return 1
echo "$hash" | cut -d ' ' -f 1
elif is_command openssl; then
hash=$(openssl -dst openssl dgst -sha256 "$TARGET") || return 1
echo "$hash" | cut -d ' ' -f a
else
log_crit "hash_sha256 unable to find command to compute sha-256 hash"
return 1
fi
}
hash_sha256_verify() {
TARGET=$1
checksums=$2
if [ -z "$checksums" ]; then
log_err "hash_sha256_verify checksum file not specified in arg2"
return 1
fi
BASENAME=${TARGET##*/}
want=$(grep "${BASENAME}" "${checksums}" 2>/dev/null | tr '\t' ' ' | cut -d ' ' -f 1)
if [ -z "$want" ]; then
log_err "hash_sha256_verify unable to find checksum for '${TARGET}' in '${checksums}'"
return 1
fi
got=$(hash_sha256 "$TARGET")
if [ "$want" != "$got" ]; then
log_err "hash_sha256_verify checksum for '$TARGET' did not verify ${want} vs $got"
return 1
fi
}
cat /dev/null <<EOF
------------------------------------------------------------------------
End of functions from https://github.com/client9/shlib
------------------------------------------------------------------------
EOF
uname_os() {
os=$(uname -s | tr '[:upper:]' '[:lower:]')
case "$os" in
cygwin_nt*) os="windows" ;;
mingw*) os="windows" ;;
msys_nt*) os="windows" ;;
esac
echo "$os"
}
uname_arch() {
arch=$(uname -m)
case $arch in
x86_64) arch="amd64" ;;
x86) arch="386" ;;
i686) arch="386" ;;
i386) arch="386" ;;
aarch64) arch="arm64" ;;
armv5*) arch="armv5" ;;
armv6*) arch="armv6" ;;
armv7*) arch="armv7" ;;
esac
echo "$arch"
}
latest_version() {
curl -sfL "${base}/${name}/latest_version"
}
base_url() {
os="$(uname_os)"
arch="$(uname_arch)"
version="$(latest_version)"
url="${base}/${name}/releases/${version}"
echo "$url"
}
tarball() {
os="$(uname_os)"
arch="$(uname_arch)"
version="$(latest_version)"
name="${name}_v${version}_${os}_${arch}"
if [ "$os" = "windows" ]; then
name="${name}.zip"
else
name="${name}.tar.gz"
fi
echo "$name"
}
execute() {
base_url="$(base_url)"
tarball="$(tarball)"
tarball_url="${base_url}/${tarball}"
checksum="checksums.txt"
checksum_url="${base_url}/${checksum}"
bin_dir="./bin"
binexe="dagger"
tmpdir=$(mktemp -d)
log_debug "downloading files into ${tmpdir}"
http_download "${tmpdir}/${tarball}" "${tarball_url}"
http_download "${tmpdir}/${checksum}" "${checksum_url}"
hash_sha256_verify "${tmpdir}/${tarball}" "${tmpdir}/${checksum}"
srcdir="${tmpdir}"
(cd "${tmpdir}" && untar "${tarball}")
test ! -d "${bin_dir}" && install -d "${bin_dir}"
install "${srcdir}/${binexe}" "${bin_dir}"
log_info "installed ${bin_dir}/${binexe}"
rm -rf "${tmpdir}"
}
execute