mirror of
https://github.com/qmk/qmk_firmware
synced 2024-11-17 17:35:30 +00:00
Add a script that simplifies running commands under docker. (#16028)
This commit is contained in:
parent
bf9569db93
commit
5f23345886
1 changed files with 59 additions and 0 deletions
59
util/docker_cmd.sh
Executable file
59
util/docker_cmd.sh
Executable file
|
@ -0,0 +1,59 @@
|
|||
#!/bin/sh
|
||||
# NOTE: This script uses tabs for indentation
|
||||
|
||||
errcho() {
|
||||
echo "$@" >&2
|
||||
}
|
||||
|
||||
USAGE="Usage: $0 <command>"
|
||||
|
||||
# Check preconditions
|
||||
for arg; do
|
||||
if [ "$arg" = "--help" ]; then
|
||||
echo "$USAGE"
|
||||
exit 0
|
||||
fi
|
||||
done
|
||||
|
||||
# Allow $RUNTIME to be overriden by the user as an environment variable
|
||||
# Else check if either docker or podman exit and set them as runtime
|
||||
# if none are found error out
|
||||
if [ -z "$RUNTIME" ]; then
|
||||
if command -v docker >/dev/null 2>&1; then
|
||||
RUNTIME="docker"
|
||||
elif command -v podman >/dev/null 2>&1; then
|
||||
RUNTIME="podman"
|
||||
else
|
||||
errcho "Error: no compatible container runtime found."
|
||||
errcho "Either podman or docker are required."
|
||||
errcho "See https://podman.io/getting-started/installation"
|
||||
errcho "or https://docs.docker.com/install/#supported-platforms"
|
||||
errcho "for installation instructions."
|
||||
exit 2
|
||||
fi
|
||||
fi
|
||||
|
||||
|
||||
# IF we are using docker on non Linux and docker-machine isn't working print an error
|
||||
# ELSE set usb_args
|
||||
if [ ! "$(uname)" = "Linux" ] && [ "$RUNTIME" = "docker" ] && ! docker-machine active >/dev/null 2>&1; then
|
||||
errcho "Error: target requires docker-machine to work on your platform"
|
||||
errcho "See http://gw.tnode.com/docker/docker-machine-with-usb-support-on-windows-macos"
|
||||
exit 3
|
||||
else
|
||||
usb_args="--privileged -v /dev:/dev"
|
||||
fi
|
||||
dir=$(pwd -W 2>/dev/null) || dir=$PWD # Use Windows path if on Windows
|
||||
|
||||
if [ "$RUNTIME" = "docker" ]; then
|
||||
uid_arg="--user $(id -u):$(id -g)"
|
||||
fi
|
||||
|
||||
# Run container and build firmware
|
||||
"$RUNTIME" run --rm -it \
|
||||
$usb_args \
|
||||
$uid_arg \
|
||||
-w /qmk_firmware \
|
||||
-v "$dir":/qmk_firmware \
|
||||
qmkfm/qmk_cli \
|
||||
"$@"
|
Loading…
Reference in a new issue