mirror of
https://github.com/super-linter/super-linter.git
synced 2024-09-17 18:07:34 -04:00
435 lines
13 KiB
Bash
Executable file
435 lines
13 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
|
|
################################################################################
|
|
############# Deploy Container to DockerHub @admiralawkbar #####################
|
|
################################################################################
|
|
|
|
# NOTES: This script is used to upload a Dockerfile to DockerHub
|
|
# under the GitHub organization
|
|
# Its based on being built from a GitHub Action, but could be easily updated
|
|
# To be ran in a different medium.
|
|
#
|
|
# PRE-Reqs:
|
|
# - Dockerfile
|
|
# - System with Docker installed
|
|
# - Global variables met
|
|
|
|
###########
|
|
# Globals #
|
|
###########
|
|
GITHUB_WORKSPACE="${GITHUB_WORKSPACE}" # GitHub Workspace
|
|
DOCKER_USERNAME="${DOCKER_USERNAME}" # Username to login to DockerHub
|
|
DOCKER_PASSWORD="${DOCKER_PASSWORD}" # Password to login to DockerHub
|
|
GPR_USERNAME="${GPR_USERNAME}" # Username to login to GitHub package registry
|
|
GPR_TOKEN="${GPR_TOKEN}" # Password to login to GitHub package registry
|
|
REGISTRY="${REGISTRY}" # What registry to upload | <GPR> or <Docker>
|
|
IMAGE_REPO="${IMAGE_REPO}" # Image repo to upload the image
|
|
IMAGE_VERSION="${IMAGE_VERSION}" # Version to tag the image
|
|
DOCKERFILE_PATH="${DOCKERFILE_PATH}" # Path to the Dockerfile to be uploaded
|
|
|
|
################################################################################
|
|
############################ FUNCTIONS BELOW ###################################
|
|
################################################################################
|
|
################################################################################
|
|
#### Function Header ###########################################################
|
|
Header()
|
|
{
|
|
echo ""
|
|
echo "-------------------------------------------------------"
|
|
echo "---- GitHub Actions Upload image to [$REGISTRY] ----"
|
|
echo "-------------------------------------------------------"
|
|
echo ""
|
|
}
|
|
################################################################################
|
|
#### Function ValidateInput ####################################################
|
|
ValidateInput()
|
|
{
|
|
# Need to validate we have the basic variables
|
|
################
|
|
# Print header #
|
|
################
|
|
echo ""
|
|
echo "----------------------------------------------"
|
|
echo "Gathering variables..."
|
|
echo "----------------------------------------------"
|
|
echo ""
|
|
|
|
#############################
|
|
# Validate GITHUB_WORKSPACE #
|
|
#############################
|
|
if [ -z "$GITHUB_WORKSPACE" ]; then
|
|
echo "ERROR! Failed to get [GITHUB_WORKSPACE]!"
|
|
echo "ERROR:[$GITHUB_WORKSPACE]"
|
|
exit 1
|
|
else
|
|
echo "Successfully found:[GITHUB_WORKSPACE], value:[$GITHUB_WORKSPACE]"
|
|
fi
|
|
|
|
#####################
|
|
# Validate REGISTRY #
|
|
#####################
|
|
if [ -z "$REGISTRY" ]; then
|
|
echo "ERROR! Failed to get [REGISTRY]!"
|
|
echo "ERROR:[$REGISTRY]"
|
|
exit 1
|
|
else
|
|
echo "Successfully found:[REGISTRY], value:[$REGISTRY]"
|
|
fi
|
|
|
|
#####################################################
|
|
# See if we need values for GitHub package Registry #
|
|
#####################################################
|
|
if [[ "$REGISTRY" == "GPR" ]]; then
|
|
#########################
|
|
# Validate GPR_USERNAME #
|
|
#########################
|
|
if [ -z "$GPR_USERNAME" ]; then
|
|
echo "ERROR! Failed to get [GPR_USERNAME]!"
|
|
echo "ERROR:[$GPR_USERNAME]"
|
|
exit 1
|
|
else
|
|
echo "Successfully found:[GPR_USERNAME], value:[$GPR_USERNAME]"
|
|
fi
|
|
|
|
######################
|
|
# Validate GPR_TOKEN #
|
|
######################
|
|
if [ -z "$GPR_TOKEN" ]; then
|
|
echo "ERROR! Failed to get [GPR_TOKEN]!"
|
|
echo "ERROR:[$GPR_TOKEN]"
|
|
exit 1
|
|
else
|
|
echo "Successfully found:[GPR_TOKEN], value:[********]"
|
|
fi
|
|
########################################
|
|
# See if we need values for Ducker hub #
|
|
########################################
|
|
elif [[ "$REGISTRY" == "Docker" ]]; then
|
|
############################
|
|
# Validate DOCKER_USERNAME #
|
|
############################
|
|
if [ -z "$DOCKER_USERNAME" ]; then
|
|
echo "ERROR! Failed to get [DOCKER_USERNAME]!"
|
|
echo "ERROR:[$DOCKER_USERNAME]"
|
|
exit 1
|
|
else
|
|
echo "Successfully found:[DOCKER_USERNAME], value:[$DOCKER_USERNAME]"
|
|
fi
|
|
|
|
############################
|
|
# Validate DOCKER_PASSWORD #
|
|
############################
|
|
if [ -z "$DOCKER_PASSWORD" ]; then
|
|
echo "ERROR! Failed to get [DOCKER_PASSWORD]!"
|
|
echo "ERROR:[$DOCKER_PASSWORD]"
|
|
exit 1
|
|
else
|
|
echo "Successfully found:[DOCKER_PASSWORD], value:[********]"
|
|
fi
|
|
###########################################
|
|
# We were not passed a registry to update #
|
|
###########################################
|
|
else
|
|
echo "ERROR! Failed to find a valid registry!"
|
|
echo "Registry:[$REGISTRY]"
|
|
exit 1
|
|
fi
|
|
|
|
|
|
#######################
|
|
# Validate IMAGE_REPO #
|
|
#######################
|
|
if [ -z "$IMAGE_REPO" ]; then
|
|
echo "ERROR! Failed to get [IMAGE_REPO]!"
|
|
echo "ERROR:[$IMAGE_REPO]"
|
|
exit 1
|
|
else
|
|
echo "Successfully found:[IMAGE_REPO], value:[$IMAGE_REPO]"
|
|
###############################################
|
|
# Need to see if GPR registry and update name #
|
|
###############################################
|
|
if [[ "$REGISTRY" == "GPR" ]]; then
|
|
NAME="docker.pkg.github/$IMAGE_REPO"
|
|
IMAGE_REPO="$NAME"
|
|
echo "Updated [IMAGE_REPO] to:[$IMAGE_REPO] for GPR"
|
|
fi
|
|
fi
|
|
|
|
##########################
|
|
# Validate IMAGE_VERSION #
|
|
##########################
|
|
if [ -z "$IMAGE_VERSION" ]; then
|
|
echo "WARN! Failed to get [IMAGE_VERSION]!"
|
|
echo "Pulling from Branch Name..."
|
|
##############################
|
|
# Get the name of the branch #
|
|
##############################
|
|
BRANCH_NAME=$(git branch --contains "$GITHUB_SHA" |awk '{print $2}' 2>&1)
|
|
|
|
#######################
|
|
# Load the error code #
|
|
#######################
|
|
ERROR_CODE=$?
|
|
|
|
##############################
|
|
# Check the shell for errors #
|
|
##############################
|
|
if [ $ERROR_CODE -ne 0 ]; then
|
|
echo "ERROR! Failed to get branch name!"
|
|
echo "ERROR:[$BRANCH_NAME]"
|
|
exit 1
|
|
fi
|
|
|
|
##################################
|
|
# Remove non alpha-numeric chars #
|
|
##################################
|
|
BRANCH_NAME=$(echo "$BRANCH_NAME" | tr -cd '[:alnum:]')
|
|
|
|
############################################
|
|
# Set the IMAGE_VERSION to the BRANCH_NAME #
|
|
############################################
|
|
IMAGE_VERSION="$BRANCH_NAME"
|
|
echo "Tag:[$IMAGE_VERSION]"
|
|
else
|
|
echo "Successfully found:[IMAGE_VERSION], value:[$IMAGE_VERSION]"
|
|
fi
|
|
|
|
############################
|
|
# Validate DOCKERFILE_PATH #
|
|
############################
|
|
if [ -z "$DOCKERFILE_PATH" ]; then
|
|
echo "ERROR! Failed to get [DOCKERFILE_PATH]!"
|
|
echo "ERROR:[$DOCKERFILE_PATH]"
|
|
exit 1
|
|
else
|
|
echo "Successfully found:[DOCKERFILE_PATH], value:[$DOCKERFILE_PATH]"
|
|
fi
|
|
}
|
|
################################################################################
|
|
#### Function Authenticate #####################################################
|
|
Authenticate()
|
|
{
|
|
################
|
|
# Pull in Vars #
|
|
################
|
|
USERNAME="$1" # Name to auth with
|
|
PASSWORD="$2" # Password to auth with
|
|
URL="$3" # Url to auth towards
|
|
NAME="$4" # name of the service
|
|
|
|
################
|
|
# Print header #
|
|
################
|
|
echo ""
|
|
echo "----------------------------------------------"
|
|
echo "Login to $NAME..."
|
|
echo "----------------------------------------------"
|
|
echo ""
|
|
|
|
###################
|
|
# Auth to service #
|
|
###################
|
|
LOGIN_CMD=$(docker login "$URL" --username "$USERNAME" --password "$PASSWORD" 2>&1)
|
|
|
|
#######################
|
|
# Load the error code #
|
|
#######################
|
|
ERROR_CODE=$?
|
|
|
|
##############################
|
|
# Check the shell for errors #
|
|
##############################
|
|
if [ $ERROR_CODE -ne 0 ]; then
|
|
# ERROR
|
|
echo "ERROR! Failed to authenticate to $NAME!"
|
|
echo "ERROR:[$LOGIN_CMD]"
|
|
exit 1
|
|
else
|
|
# SUCCESS
|
|
echo "Successfully authenticated to $NAME!"
|
|
fi
|
|
}
|
|
################################################################################
|
|
#### Function BuildImage #######################################################
|
|
BuildImage()
|
|
{
|
|
################
|
|
# Print header #
|
|
################
|
|
echo ""
|
|
echo "----------------------------------------------"
|
|
echo "Building the DockerFile image..."
|
|
echo "----------------------------------------------"
|
|
echo ""
|
|
|
|
################################
|
|
# Validate the DOCKERFILE_PATH #
|
|
################################
|
|
if [ ! -f "$DOCKERFILE_PATH" ]; then
|
|
# No file found
|
|
echo "ERROR! failed to find Dockerfile at:[$DOCKERFILE_PATH]"
|
|
echo "Please make sure you give full path!"
|
|
echo "Example:[/configs/Dockerfile] or [Dockerfile] if at root directory"
|
|
exit 1
|
|
fi
|
|
|
|
###################
|
|
# Build the image #
|
|
###################
|
|
docker build --no-cache -t "$IMAGE_REPO:$IMAGE_VERSION" -f "$DOCKERFILE_PATH" . 2>&1
|
|
|
|
#######################
|
|
# Load the error code #
|
|
#######################
|
|
ERROR_CODE=$?
|
|
|
|
##############################
|
|
# Check the shell for errors #
|
|
##############################
|
|
if [ $ERROR_CODE -ne 0 ]; then
|
|
# ERROR
|
|
echo "ERROR! failed to [build] Dockerfile!"
|
|
exit 1
|
|
else
|
|
# SUCCESS
|
|
echo "Successfully Built image!"
|
|
echo "Info:[$BUILD_CMD]"
|
|
fi
|
|
}
|
|
################################################################################
|
|
#### Function UploadImage ######################################################
|
|
UploadImage()
|
|
{
|
|
################
|
|
# Print header #
|
|
################
|
|
echo ""
|
|
echo "----------------------------------------------"
|
|
echo "Uploading the DockerFile image to $REGISTRY..."
|
|
echo "----------------------------------------------"
|
|
echo ""
|
|
|
|
############################################
|
|
# Upload the docker image that was created #
|
|
############################################
|
|
docker push "$IMAGE_REPO:$IMAGE_VERSION" 2>&1
|
|
|
|
#######################
|
|
# Load the error code #
|
|
#######################
|
|
ERROR_CODE=$?
|
|
|
|
##############################
|
|
# Check the shell for errors #
|
|
##############################
|
|
if [ $ERROR_CODE -ne 0 ]; then
|
|
# ERROR
|
|
echo "ERROR! failed to [upload] Dockerfile!"
|
|
exit 1
|
|
else
|
|
# SUCCESS
|
|
echo "Successfully Uploaded Docker image to $REGISTRY!"
|
|
fi
|
|
|
|
#########################
|
|
# Get Image information #
|
|
#########################
|
|
IFS=$'\n' # Set the delimit to newline
|
|
GET_INFO_CMD=$(docker images | grep "$IMAGE_REPO" | grep "$IMAGE_VERSION" 2>&1)
|
|
|
|
#######################
|
|
# Load the error code #
|
|
#######################
|
|
ERROR_CODE=$?
|
|
|
|
##############################
|
|
# Check the shell for errors #
|
|
##############################
|
|
if [ $ERROR_CODE -ne 0 ]; then
|
|
# ERROR
|
|
echo "ERROR! Failed to get information about built Image!"
|
|
echo "ERROR:[$GET_INFO_CMD]"
|
|
exit 1
|
|
else
|
|
################
|
|
# Get the data #
|
|
################
|
|
REPO=$(echo "$GET_INFO_CMD" | awk '{print $1}')
|
|
TAG=$(echo "$GET_INFO_CMD" | awk '{print $2}')
|
|
IMAGE_ID=$(echo "$GET_INFO_CMD" | awk '{print $3}')
|
|
# shellcheck disable=SC2116
|
|
SIZE=$(echo "${GET_INFO_CMD##* }")
|
|
|
|
###################
|
|
# Print the goods #
|
|
###################
|
|
echo "----------------------------------------------"
|
|
echo "Docker Image Details:"
|
|
echo "Repository:[$REPO]"
|
|
echo "Tag:[$TAG]"
|
|
echo "Image_ID:[$IMAGE_ID]"
|
|
echo "Size:[$SIZE]"
|
|
echo "----------------------------------------------"
|
|
fi
|
|
}
|
|
################################################################################
|
|
#### Function Footer ###########################################################
|
|
Footer()
|
|
{
|
|
echo ""
|
|
echo "-------------------------------------------------------"
|
|
echo "The step has completed"
|
|
echo "-------------------------------------------------------"
|
|
echo ""
|
|
}
|
|
################################################################################
|
|
################################## MAIN ########################################
|
|
################################################################################
|
|
|
|
##########
|
|
# Header #
|
|
##########
|
|
Header
|
|
|
|
##################
|
|
# Validate Input #
|
|
##################
|
|
ValidateInput
|
|
|
|
###################
|
|
# Build the image #
|
|
###################
|
|
BuildImage
|
|
|
|
######################
|
|
# Login to DockerHub #
|
|
######################
|
|
if [[ "$REGISTRY" == "Docker" ]]; then
|
|
# Authenticate "Username" "Password" "Url" "Name"
|
|
Authenticate "$DOCKER_USERNAME" "$DOCKER_PASSWORD" "" "Dockerhub"
|
|
|
|
####################################
|
|
# Login to GitHub Package Registry #
|
|
####################################
|
|
elif [[ "$REGISTRY" == "GPR" ]]; then
|
|
# Authenticate "Username" "Password" "Url" "Name"
|
|
Authenticate "$GPR_USERNAME" "$GPR_TOKEN" "https://docker.pkg.github.com" "GitHub Package Registry"
|
|
|
|
else
|
|
#########
|
|
# ERROR #
|
|
#########
|
|
echo "ERROR! Registry not set correctly!"
|
|
echo "Registry:[$REGISTRY]"
|
|
exit 1
|
|
fi
|
|
|
|
####################
|
|
# Upload the image #
|
|
####################
|
|
UploadImage
|
|
|
|
##########
|
|
# Footer #
|
|
##########
|
|
Footer
|