Merge pull request #40 from github/addDevDeployment

adding dev stuff

.automation/cleanup-docker.sh

@@ -0,0 +1,288 @@
+#!/bin/bash
+
+################################################################################
+############# Cleanup Container on DockerHub @admiralawkbar ####################
+################################################################################
+
+# NOTES: This script is used to remove a tagged image on DockerHub
+# 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
+IMAGE_REPO="${IMAGE_REPO}"              # Image repo to upload the image
+IMAGE_VERSION="${GITHUB_SHA}"           # 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 remove image from DockerHub ------"
+  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 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
+
+  #######################
+  # 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]"
+  fi
+
+  ##########################
+  # Validate IMAGE_VERSION #
+  ##########################
+  if [ -z "$IMAGE_VERSION" ]; then
+    echo "ERROR! Failed to get [IMAGE_VERSION]!"
+    echo "ERROR:[$IMAGE_VERSION]"
+    exit 1
+  else
+    echo "Successfully found:[IMAGE_VERSION], value:[$IMAGE_VERSION]"
+  fi
+
+  ##################################################
+  # Check if we need to get the name of the branch #
+  ##################################################
+  if [[ "$IMAGE_VERSION" != "latest" ]]; then
+    ##############################
+    # 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-numberic chars #
+    ###################################
+    BRANCH_NAME=$(echo "$BRANCH_NAME" | tr -cd '[:alnum:]')
+
+    ############################################
+    # Set the IMAGE_VERSION to the BRANCH_NAME #
+    ############################################
+    IMAGE_VERSION="$BRANCH_NAME"
+  else
+    #############################################
+    # Image is 'latest' and we will not destroy #
+    #############################################
+    echo "Image Tag is set to:[latest]..."
+    echo "We will never destroy latest..."
+    echo "Bye!"
+    exit 0
+  fi
+}
+################################################################################
+#### Function LoginToDocker ####################################################
+LoginToDocker()
+{
+  ################
+  # Print header #
+  ################
+  echo ""
+  echo "----------------------------------------------"
+  echo "Login to DockerHub..."
+  echo "----------------------------------------------"
+  echo ""
+
+  ######################
+  # Login to DockerHub #
+  ######################
+  LOGIN_CMD=$(docker login --username "$DOCKER_USERNAME" --password "$DOCKER_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 DockerHub!"
+    echo "ERROR:[$LOGIN_CMD]"
+    exit 1
+  else
+    # SUCCESS
+    echo "Successfully authenticated to DockerHub!"
+  fi
+}
+################################################################################
+#### Function RemoveImage ######################################################
+RemoveImage()
+{
+  ################
+  # Print header #
+  ################
+  echo ""
+  echo "----------------------------------------------"
+  echo "Removing the DockerFile image:[$IMAGE_REPO:$IMAGE_VERSION]"
+  echo "----------------------------------------------"
+  echo ""
+
+  #####################################
+  # Create Token to auth to DockerHub #
+  #####################################
+  TOKEN=$(curl -s -k \
+    -H "Content-Type: application/json" \
+    -X POST \
+    -d "{\"username\": \"$DOCKER_USERNAME\", \"password\": \"$DOCKER_PASSWORD\"}" \
+    "https://hub.docker.com/v2/users/login/" | jq -r .token 2>&1)
+
+    #######################
+    # Load the ERROR_CODE #
+    #######################
+    ERROR_CODE=$?
+
+    ##############################
+    # Check the shell for errors #
+    ##############################
+    if [ $ERROR_CODE -ne 0 ]; then
+      # ERROR
+      echo "ERROR! Failed to gain token from DockerHub!"
+      echo "ERROR:[$TOKEN]"
+      exit 1
+    else
+      # SUCCESS
+      echo "Successfully gained auth token from DockerHub!"
+    fi
+
+  #################################
+  # Remove the tag from DockerHub #
+  #################################
+  REMOVE_CMD=$(curl "https://hub.docker.com/v2/repositories/$IMAGE_REPO/tags/$IMAGE_VERSION/" \
+    -X DELETE \
+    -H "Authorization: JWT $TOKEN" 2>&1)
+
+  #######################
+  # Load the ERROR_CODE #
+  #######################
+  ERROR_CODE=$?
+
+  ##############################
+  # Check the shell for errors #
+  ##############################
+  if [ $ERROR_CODE -ne 0 ]; then
+    # ERROR
+    echo "ERROR! Failed to remove tag from DockerHub!"
+    echo "ERROR:[$REMOVE_CMD]"
+    exit 1
+  else
+    # SUCCESS
+    echo "Successfully [removed] Docker image tag:[$IMAGE_VERSION] from DockerHub!"
+  fi
+}
+################################################################################
+#### Function Footer ###########################################################
+Footer()
+{
+  echo ""
+  echo "-------------------------------------------------------"
+  echo "The step has completed"
+  echo "-------------------------------------------------------"
+  echo ""
+}
+################################################################################
+################################## MAIN ########################################
+################################################################################
+
+##########
+# Header #
+##########
+Header
+
+##################
+# Validate Input #
+##################
+ValidateInput
+
+######################
+# Login to DockerHub #
+######################
+LoginToDocker
+
+####################
+# Remove the image #
+####################
+RemoveImage
+
+##########
+# Footer #
+##########
+Footer

.automation/upload-docker.sh

@@ -98,9 +98,37 @@ ValidateInput()
   # Validate IMAGE_VERSION #
   ##########################
   if [ -z "$IMAGE_VERSION" ]; then
-    echo "ERROR! Failed to get [IMAGE_VERSION]!"
+    echo "WARN! Failed to get [IMAGE_VERSION]!"
-    echo "ERROR:[$IMAGE_VERSION]"
+    echo "Pulling from Branch Name..."
-    exit 1
+    ##############################
+    # 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-numberic 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
@@ -180,7 +208,7 @@ BuildImage()
   ###################
   # Build the image #
   ###################
-  BUILD_CMD=$(docker build --no-cache -t "$IMAGE_REPO:$IMAGE_VERSION" -f "$DOCKERFILE_PATH" . 2>&1)
+  docker build --no-cache -t "$IMAGE_REPO:$IMAGE_VERSION" -f "$DOCKERFILE_PATH" . 2>&1
 
   #######################
   # Load the error code #
@@ -193,7 +221,6 @@ BuildImage()
   if [ $ERROR_CODE -ne 0 ]; then
     # ERROR
     echo "ERROR! failed to [build] Dockerfile!"
-    echo "ERROR:[$BUILD_CMD]"
     exit 1
   else
     # SUCCESS
@@ -214,11 +241,10 @@ UploadImage()
   echo "----------------------------------------------"
   echo ""
 
-
   ############################################
   # Upload the docker image that was created #
   ############################################
-  UPLOAD_CMD=$(docker push "$IMAGE_REPO:$IMAGE_VERSION" 2>&1)
+  docker push "$IMAGE_REPO:$IMAGE_VERSION" 2>&1
 
   #######################
   # Load the error code #
@@ -230,13 +256,11 @@ UploadImage()
   ##############################
   if [ $ERROR_CODE -ne 0 ]; then
     # ERROR
-    echo "ERROR! failed to [build] Dockerfile!"
+    echo "ERROR! failed to [upload] Dockerfile!"
-    echo "ERROR:[$UPLOAD_CMD]"
     exit 1
   else
     # SUCCESS
     echo "Successfully Uploaded Docker image to DockerHub!"
-    echo "Info:[$UPLOAD_CMD]"
   fi
 
   #########################

.github/workflows/cleanup-DEV.yml

@@ -0,0 +1,52 @@
+---
+##########################
+##########################
+## Cleanup Docker Image ##
+##########################
+##########################
+
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+#
+
+########################################
+# Run job when PR is merged and closed #
+########################################
+
+on:
+  pull_request:
+    types: [closed]
+
+###############
+# Set the Job #
+###############
+jobs:
+  build:
+    # Name the Job
+    name: Cleanup Docker Image - DEV
+    # Set the agent to run on
+    runs-on: ubuntu-latest
+    ##################
+    # Load all steps #
+    ##################
+    steps:
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        if: github.event.pull_request.merged
+        uses: actions/checkout@master
+
+      ######################
+      # Run Removal script #
+      ######################
+      - name: Remove old image from DockerHub
+        if: github.event.pull_request.merged
+        env:
+          # Set the Env Vars
+          DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+          IMAGE_REPO: admiralawkbar/super-linter
+        shell: bash
+        run: .automation/cleanup-docker.sh

.github/workflows/deploy-DEV.yml

@@ -0,0 +1,54 @@
+---
+#########################
+#########################
+## Deploy Docker Image ##
+#########################
+#########################
+
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+#
+
+#######################################
+# Start the job on all push to master #
+#######################################
+#############################
+# Start the job on all push #
+#############################
+on:
+  push:
+    branches-ignore:
+      - 'master'
+
+###############
+# Set the Job #
+###############
+jobs:
+  build:
+    # Name the Job
+    name: Deploy Docker Image - DEV
+    # Set the agent to run on
+    runs-on: ubuntu-latest
+    ##################
+    # Load all steps #
+    ##################
+    steps:
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        uses: actions/checkout@master
+
+      #####################
+      # Run Deploy script #
+      #####################
+      - name: Deploy image to DockerHub
+        env:
+          # Set the Env Vars
+          DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+          IMAGE_REPO: admiralawkbar/super-linter
+          DOCKERFILE_PATH: Dockerfile
+        shell: bash
+        run: .automation/upload-docker.sh

.github/workflows/deploy-PROD.yml

@@ -24,7 +24,7 @@ on:
 jobs:
   build:
     # Name the Job
-    name: Deploy Docker Image
+    name: Deploy Docker Image - PROD
     # Set the agent to run on
     runs-on: ubuntu-latest
     ##################