Add Job Summary

Author: smashedr

.github/workflows/test.yaml

@@ -15,9 +15,9 @@ env:
 jobs:
   test:
     name: "Test"
+    if: ${{ !contains(github.event.head_commit.message, '#notest') }}
     runs-on: ubuntu-latest
     timeout-minutes: 5
-    if: ${{ !contains(github.event.head_commit.message, '#notest') }}
 
     steps:
       - name: "Checkout"
@@ -28,12 +28,14 @@ jobs:
       #    cat "${GITHUB_EVENT_PATH}"
 
       - name: "Write YAML Basic"
+        if: ${{ !github.event.act }}
         uses: teunmooij/yaml@v1
         with:
           data: '{"version":"3.8","services":{"alpine":{"image":"alpine:latest","command":"tail -f /dev/null"}}}'
           to-file: "docker-compose.yaml"
 
-      - name: "Test Action Basic"
+      - name: "Test SSH Key"
+        if: ${{ !github.event.act }}
         id: test1
         uses: ./
         with:
@@ -51,7 +53,7 @@ jobs:
           data: '{"version":"3.8","services":{"alpine":{"image":"${{ env.PRIVATE_IMAGE }}","command":"tail -f /dev/null"}}}'
           to-file: "docker-compose.yaml"
 
-      - name: "Test Action Private"
+      - name: "Test Password w/ Registry"
         id: test2
         uses: ./
         with:
@@ -60,8 +62,8 @@ jobs:
           host: ${{ secrets.DOCKER_HOST }}
           port: ${{ secrets.DOCKER_PORT }}
           user: ${{ secrets.DOCKER_USER }}
-          #pass: ${{ secrets.DOCKER_PASS }}
-          ssh_key: "${{ secrets.DOCKER_SSH_KEY }}"
+          pass: ${{ secrets.DOCKER_PASS }}
+          #ssh_key: "${{ secrets.DOCKER_SSH_KEY }}"
           #registry_host: "ghcr.io"
           registry_user: ${{ vars.DOCKER_HUB_USER }}
           registry_pass: ${{ secrets.DOCKER_HUB_PASS }}

Dockerfile

@@ -1,7 +1,7 @@
-FROM docker:24-dind
+FROM docker:28-dind
 
 RUN apk add --update --no-cache bash sshpass
 
-COPY src/main.sh /main.sh
+COPY src/ /src
 
-ENTRYPOINT ["bash", "/main.sh"]
+ENTRYPOINT ["bash", "/src/main.sh"]

README.md

@@ -39,6 +39,7 @@ _Portainer Users_: You can deploy directly to Portainer with: [cssnr/portainer-s
 | registry_host |        -         | -                     | Registry Authentication Host \*   |
 | registry_user |        -         | -                     | Registry Authentication User \*   |
 | registry_pass |        -         | -                     | Registry Authentication Pass \*   |
+| summary       |        -         | `true`                | Add Job Summary                   |
 
 **pass/ssh_key** - You must provide either a `pass` or `ssh_key`
 

action.yaml

@@ -24,8 +24,8 @@ inputs:
     required: false
   file:
     description: "Docker Compose File"
-    default: "docker-compose.yaml"
     required: false
+    default: "docker-compose.yaml"
   name:
     description: "Docker Stack Name"
     required: true
@@ -44,6 +44,10 @@ inputs:
   registry_pass:
     description: "Registry Auth Password"
     required: false
+  summary:
+    description: "Add Summary to Job"
+    required: false
+    default: "true"
 
 runs:
   using: "docker"

event.json

@@ -0,0 +1,3 @@
+{
+  "act": true
+}

src/main.sh

@@ -1,79 +1,90 @@
 #!/usr/bin/env bash
+# https://github.com/cssnr/stack-deploy-action
 
 set -e
 
-echo "Running: ${0} as: $(whoami) in: $(pwd)"
-
 function cleanup_trap() {
     _ST="$?"
     if [[ "${_ST}" != "0" ]]; then
-        echo -e "\u001b[31;1mScript Exited with Error: ${_ST}"
+        echo -e "⛔ \u001b[31;1mFailed to Deploy Stack! See logs for details..."
     fi
     if [ -z "${INPUT_SSH_KEY}" ];then
-        echo -e "\u001b[35mCleaning Up authorized_keys on: ${INPUT_HOST}"
+        echo -e "Cleaning Up authorized_keys on: \u001b[36;1m${INPUT_HOST}"
         ssh -p "${INPUT_PORT}" "${INPUT_USER}@${INPUT_HOST}" \
             "sed -i '/docker-stack-deploy-action/d' ~/.ssh/authorized_keys"
     fi
     if [[ "${_ST}" == "0" ]]; then
-        echo -e "\u001b[32;1mFinished Success."
+        echo -e "✅ \u001b[32;1mFinished Success."
     fi
     exit "${_ST}"
 }
 
+echo "::group::Starting Stack Deploy Action"
+echo "User: $(whoami)"
+echo "Script: ${0}"
+echo -e "Directory: $(pwd)"
 mkdir -p /root/.ssh
 chmod 0700 /root/.ssh
 ssh-keyscan -p "${INPUT_PORT}" -H "${INPUT_HOST}" >> /root/.ssh/known_hosts
+echo "::endgroup::"
 
 if [ -z "${INPUT_SSH_KEY}" ];then
-    echo -e "\u001b[36mCreating and Copying SSH Key to: ${INPUT_HOST}"
+    echo -e "::group::Copying SSH Key to: \u001b[36;1m${INPUT_HOST}"
     ssh-keygen -q -f /root/.ssh/id_rsa -N "" -C "docker-stack-deploy-action"
     eval "$(ssh-agent -s)"
     ssh-add /root/.ssh/id_rsa
-
-    sshpass -p "${INPUT_PASS}" \
-        ssh-copy-id -p "${INPUT_PORT}" -i /root/.ssh/id_rsa \
-            "${INPUT_USER}@${INPUT_HOST}"
+    mkdir ~/.ssh
+    sshpass -eINPUT_PASS \
+        ssh-copy-id -i /root/.ssh/id_rsa -o ConnectTimeout=15 \
+            -p "${INPUT_PORT}" "${INPUT_USER}@${INPUT_HOST}"
 else
-    echo -e "\u001b[36mAdding SSH Key to SSH Agent"
+    echo "::group::Adding SSH Key to SSH Agent"
     echo "${INPUT_SSH_KEY}" > /root/.ssh/id_rsa
     chmod 0600 /root/.ssh/id_rsa
     eval "$(ssh-agent -s)"
     ssh-add /root/.ssh/id_rsa
 fi
+echo "::endgroup::"
 
 trap cleanup_trap EXIT HUP INT QUIT PIPE TERM
 
-echo -e "\u001b[36mVerifying Docker and Setting Context."
-ssh -p "${INPUT_PORT}" "${INPUT_USER}@${INPUT_HOST}" "docker info" > /dev/null
-
+echo "::group::Verifying Docker and Setting Context."
+ssh -o BatchMode=yes -o ConnectTimeout=15 -p "${INPUT_PORT}" \
+    "${INPUT_USER}@${INPUT_HOST}" "docker info" > /dev/null
 if ! docker context inspect remote >/dev/null 2>&1;then
     docker context create remote --docker "host=ssh://${INPUT_USER}@${INPUT_HOST}:${INPUT_PORT}"
 fi
 docker context use remote
 docker context ls
+echo "::endgroup::"
 
 if [ -n "${INPUT_ENV_FILE}" ];then
-    echo -e "\u001b[36mSourcing Environment File: \u001b[37;1m${INPUT_ENV_FILE}"
+    echo -e "::group::Sourcing Environment File: \u001b[36;1m${INPUT_ENV_FILE}"
     stat "${INPUT_ENV_FILE}"
     set -a
     # shellcheck disable=SC1090
     source "${INPUT_ENV_FILE}"
-    # echo TRAEFIK_HOST: "${TRAEFIK_HOST}"
-    # export ENV_FILE="${INPUT_ENV_FILE}"
+echo "::endgroup::"
 fi
 
 if [[ -n "${INPUT_REGISTRY_USER}" && -n "${INPUT_REGISTRY_PASS}" ]];then
-    echo -e "\u001b[36mLogging in to Registry: \u001b[37;1m${INPUT_REGISTRY_HOST:-Docker Hub}"
+    echo -e "::group::Logging in to Registry: \u001b[36;1m${INPUT_REGISTRY_HOST:-Docker Hub}"
     echo "${INPUT_REGISTRY_PASS}" |
         docker login --username "${INPUT_REGISTRY_USER}" --password-stdin "${INPUT_REGISTRY_HOST}"
     INPUT_REGISTRY_AUTH="true"
+    echo "::endgroup::"
 fi
 
+echo -e "Deploying Stack: \u001b[36;1m${INPUT_NAME}"
 EXTRA_ARGS=()
 if [[ -n "${INPUT_REGISTRY_AUTH}" ]];then
-    echo -e "Adding extra arg: --with-registry-auth"
+    echo -e "Enabling Registry Authentication"
     EXTRA_ARGS+=("--with-registry-auth")
 fi
+# shellcheck disable=SC2034
+STACK_RESULTS=$(docker stack deploy -c "${INPUT_FILE}" "${INPUT_NAME}" "${EXTRA_ARGS[@]}")
 
-echo -e "\u001b[36mDeploying Stack: \u001b[37;1m${INPUT_NAME}"
-docker stack deploy -c "${INPUT_FILE}" "${INPUT_NAME}" "${EXTRA_ARGS[@]}"
+if [[ "${INPUT_SUMMARY}" == "true" ]];then
+    echo "📝 Writing Job Summary"
+    source /src/summary.sh >> "${GITHUB_STEP_SUMMARY}"
+fi

src/summary.sh

@@ -0,0 +1,11 @@
+cat << EOM
+## Stack Deploy Action
+
+🎉 Stack \`${INPUT_NAME}\` Successfully Deployed.
+
+\`\`\`text
+${STACK_RESULTS}
+\`\`\`
+
+[Report an issue or request a feature](https://github.com/cssnr/stack-deploy-action?tab=readme-ov-file#readme)
+EOM