Add reusable client and CI workflows

Author: integrii

.github/workflows/ci.yml

@@ -0,0 +1,14 @@
+name: Build
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build example container
+        run: docker build .

.github/workflows/release.yml

@@ -0,0 +1,27 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  push-image:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Log in to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          push: true
+          tags: ghcr.io/${{ github.repository_owner }}/bash-check:${{ github.ref_name }}

README.md

@@ -2,11 +2,11 @@
 
 This directory demonstrates a minimal Kuberhealthy check written in Bash.
 
-The [`check.sh`](check.sh) script reads the Kuberhealthy run UUID and reporting URL from the `KH_RUN_UUID` and `KH_REPORTING_URL` environment variables that Kuberhealthy sets on checker pods. It then reports success or failure back to Kuberhealthy.
+The reusable [`kuberhealthy-client.sh`](kuberhealthy-client.sh) library exposes helper functions for reporting results. The [`check.sh`](check.sh) example sources the library, reads the Kuberhealthy run UUID and reporting URL from the `KH_RUN_UUID` and `KH_REPORTING_URL` environment variables that Kuberhealthy sets on checker pods, and then reports success or failure back to Kuberhealthy.
 
 ## Using the example
 
-1. **Add your logic** – Replace the placeholder section in `check.sh` with commands that verify the condition you care about. Call `report_success` when the check passes or `report_failure "message"` when it fails.
+1. **Add your logic** – Replace the placeholder section in `check.sh` with commands that verify the condition you care about. Call `kh::report_success` when the check passes or `kh::report_failure "message"` when it fails.
 2. **Build the image** – Build a container that runs the script:
 
    ```sh
@@ -37,3 +37,20 @@ The [`check.sh`](check.sh) script reads the Kuberhealthy run UUID and reporting
    ```
 
 When the pod runs, `check.sh` will report its result to Kuberhealthy. Set the `FAIL=true` environment variable to simulate a failure.
+
+## Using the client library in your own scripts
+
+Copy `kuberhealthy-client.sh` into your repository and source it from your Kuberhealthy check scripts:
+
+```bash
+#!/usr/bin/env bash
+set -euo pipefail
+source "kuberhealthy-client.sh"
+kh::init
+
+if my_check_logic; then
+  kh::report_success
+else
+  kh::report_failure "something went wrong"
+fi
+```

check.sh

@@ -1,36 +1,14 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
-# Load Kuberhealthy run metadata from environment variables provided to the pod.
-UUID="${KH_RUN_UUID:-}"
-REPORT_URL="${KH_REPORTING_URL:-}"
-
-if [[ -z "$UUID" || -z "$REPORT_URL" ]]; then
-  echo "KH_RUN_UUID and KH_REPORTING_URL must be set" >&2
-  exit 1
-fi
-
-report_success() {
-  curl -sS -X POST \
-    -H "Content-Type: application/json" \
-    -H "kh-run-uuid: ${UUID}" \
-    -d '{"ok":true,"errors":[]}' \
-    "${REPORT_URL}"
-}
-
-report_failure() {
-  local msg="$1"
-  curl -sS -X POST \
-    -H "Content-Type: application/json" \
-    -H "kh-run-uuid: ${UUID}" \
-    -d '{"ok":false,"errors":["'"${msg}"'"]}' \
-    "${REPORT_URL}"
-}
+# Source the Kuberhealthy client library and initialize it.
+source "$(dirname "$0")/kuberhealthy-client.sh"
+kh::init
 
 # Add your check logic here. For example purposes, this check reports success
 # unless the FAIL environment variable is set to "true".
 if [[ "${FAIL:-}" == "true" ]]; then
-  report_failure "FAIL was set to true"
+  kh::report_failure "FAIL was set to true"
 else
-  report_success
+  kh::report_success
 fi

kuberhealthy-client.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+# Helper functions for reporting results to Kuberhealthy from bash checks.
+# Source this file in your check script and call kh::init before reporting results.
+
+kh::init() {
+  UUID="${KH_RUN_UUID:-}"
+  REPORT_URL="${KH_REPORTING_URL:-}"
+  if [[ -z "$UUID" || -z "$REPORT_URL" ]]; then
+    echo "KH_RUN_UUID and KH_REPORTING_URL must be set" >&2
+    return 1
+  fi
+}
+
+kh::report_success() {
+  curl -sS -X POST \
+    -H "Content-Type: application/json" \
+    -H "kh-run-uuid: ${UUID}" \
+    -d '{"ok":true,"errors":[]}' \
+    "${REPORT_URL}"
+}
+
+kh::report_failure() {
+  local msg="$1"
+  curl -sS -X POST \
+    -H "Content-Type: application/json" \
+    -H "kh-run-uuid: ${UUID}" \
+    -d '{"ok":false,"errors":["'"${msg}"'"]}' \
+    "${REPORT_URL}"
+}
+