Task: Release v2.3.0 - Logging improvements q1-2026

.githooks/README.md

@@ -0,0 +1,46 @@
+# Now using githooks for automation
+
+- Pre-commit hook will lint Ruby files before committing and reset[^*] if fails.
+- Post-commit hook will run tests after committing and reset[^*] if fails.
+- Pre-push hook to build and verify Gem construction and prevent push if fails.
+- Allows skipping of hooks on specific branches:
+  - `hotfix`
+  - `rebase`
+  - `production`
+- You can also manually skip hooks using the `--no-verify` flag on any branch
+  commit:
+
+    ```sh
+      git commit --no-verify -m "skipping hooks on this commit"
+    ```
+
+  or
+
+    ```sh
+      git push --no-verify
+    ```
+
+## Setup
+
+Use the following commands to enable the hooks to initiate hooks onto your local
+copy of the repository, otherwise the hooks will not be triggered to run
+automatically:
+
+1. set the path to the hooks in the repository gitconfig:
+
+    ```sh
+      git config core.hooksPath '.githooks'
+    ```
+
+2. set permissions for the hooks:
+
+    ```sh
+      chmod +x .githooks/pre-commit .githooks/post-commit .githooks/pre-push
+    ```
+
+### Additional information
+
+- <https://github.com/epimorphics/githooks/blob/main/README.md>
+- <https://git-scm.com/docs/githooks>
+
+[^*]: instructs reset to find the first parent ref of `HEAD`

.githooks/common.sh

@@ -0,0 +1,79 @@
+#!/bin/bash
+# Common utilities and functions for git hooks
+#
+# Environment variables:
+#   NO_COLOR - Set to any value to disable colored output (e.g., NO_COLOR=1 git commit)
+
+# Check if color output is disabled (set NO_COLOR=1 to disable)
+: "${NO_COLOR:=}"
+
+# Initialize branch name from filtered branch list
+init_branch_name() {
+  local list="issue spike task"
+  local listRE="^($(printf '%s\n' "$list" | tr ' ' '|'))/"
+
+  BRANCH_NAME=$(git branch --show-current | grep -E "$listRE" | sed 's/* //')
+}
+
+# Check if hook should be skipped based on branch, reflog action, or flags
+should_skip_hook() {
+  # Skip on specific branches
+  if echo "$BRANCH_NAME" | grep -qE '^(hotfix|rebase|prod(uction)?)$'; then
+    return 0
+  fi
+
+  # Skip if Git reflog indicates an amend (reliable for GUI flows)
+  if [ "${GIT_REFLOG_ACTION:-}" = "commit (amend)" ]; then
+    return 0
+  fi
+
+  # Fallback: check parent process for --no-verify or --amend flags
+  local ppid_cmd
+  ppid_cmd=$(ps -ocommand= -p $PPID 2>/dev/null || echo "")
+  if [[ "$ppid_cmd" == *"--no-verify"* ]] || [[ "$ppid_cmd" == *"--amend"* ]]; then
+    return 0
+  fi
+
+  return 1
+}
+
+# Print colored status messages (respects NO_COLOR environment variable)
+print_header() {
+  if [ -z "$NO_COLOR" ]; then
+    printf '\n\033[0;105m%s\033[0m\n' "$1"
+  else
+    printf '\n%s\n' "$1"
+  fi
+}
+
+print_success() {
+  if [ -z "$NO_COLOR" ]; then
+    printf '\n\033[0;32m%s\033[0m\n' "$1"
+  else
+    printf '\n%s\n' "$1"
+  fi
+}
+
+print_warning() {
+  if [ -z "$NO_COLOR" ]; then
+    printf '\n\033[0;33m%s\033[0m\n' "$1"
+  else
+    printf '\n%s\n' "$1"
+  fi
+}
+
+print_error() {
+  if [ -z "$NO_COLOR" ]; then
+    printf '\n\033[0;31m%s\033[0m\n' "$1"
+  else
+    printf '\n%s\n' "$1"
+  fi
+}
+
+print_info() {
+  if [ -z "$NO_COLOR" ]; then
+    printf '\033[0;33m%s\033[0m\n' "$1"
+  else
+    printf '%s\n' "$1"
+  fi
+}

.githooks/post-commit

@@ -0,0 +1,70 @@
+#!/bin/bash
+# This hook is called by "git commit" after the commit message editor
+# is closed. The default behavior is to run the tests and if they pass,
+# the commit is allowed to proceed. If the tests fail, the commit is
+# aborted. The hook can be bypassed by using the --no-verify option
+# when running "git commit".
+
+# Source common hook utilities
+. "$(dirname "$0")/common.sh"
+
+# Initialize branch name
+init_branch_name
+
+print_header "Checking \"$BRANCH_NAME\"..."
+
+# Skip if on specific branches, or when amending or --no-verify flag is set
+if should_skip_hook; then
+  print_warning "Skipping post-commit hook... 🤨"
+  exit 0
+fi
+
+# Check for existence of "new or modified" test files
+NEW_TEST_FILES="$(git diff --diff-filter=ACDM --name-only --cached | grep -E '(./test/*)$')"
+# Get all test files to run tests
+CURRENT_TEST_FILES="$(git ls-files | grep -i -E '(_test\.rb)$')"
+
+RAILS_TEST_EXIT_CODE=0
+WORK_DONE=0
+
+if [ -n "$NEW_TEST_FILES" ]; then
+  #Count the number of new test files
+  file_count=$(echo "$NEW_TEST_FILES" | wc -l)
+  # Check if there are any new test files
+  if [ "$file_count" -ne 0 ]; then
+    print_warning "Found $file_count new test files in \"$BRANCH_NAME\"  🎉."
+  fi
+
+  for file in $NEW_TEST_FILES; do
+    # if file is system test file run rake test:system filename
+    if [[ "$file" == *"./test/system/*_test.rb" ]]; then
+      print_warning "Running system test for \"$file\"..."
+      bundle exec rake test:system "$file"
+    else
+      print_warning "Running unit test on \"$file\"..."
+      bundle exec rake test "$file"
+    fi
+    # Capture the exit code from the test command to determine if it passed or failed
+    if [ $? -ne 0 ]; then
+      RAILS_TEST_EXIT_CODE=1
+    fi
+  done
+  WORK_DONE=1
+elif [ -n "$CURRENT_TEST_FILES" ]; then
+  print_warning "No new tests found, running all Rails Tests ..."
+  make test
+  RAILS_TEST_EXIT_CODE=$?
+  WORK_DONE=1
+else
+  print_error "No tests found in \"$BRANCH_NAME\". 🤨"
+  RAILS_TEST_EXIT_CODE=1
+fi
+
+if [ ! "$RAILS_TEST_EXIT_CODE" -eq 0 ]; then
+  git reset HEAD~
+  print_error "Cannot commit, tests are failing. Use --no-verify to force commit. 😖"
+  exit 1
+fi
+
+print_success "All tests are green, committing... 🎉"
+exit 0

.githooks/pre-commit

@@ -3,50 +3,55 @@
 # beware if you are in the habit of committing only partial modifications to a file:
 # THIS HOOK WILL ADD ALL MODIFICATIONS TO A FILE TO THE COMMIT IF ANY FILE WAS CHANGED BY LINTING
 
-list="issue spike task"
+# Source common hook utilities
+. "$(dirname "$0")/common.sh"
 
-listRE="^($(printf '%s\n' "$list" | tr ' ' '|'))/"
+# Initialize branch name
+init_branch_name
 
-BRANCH_NAME=$(git branch --show-current | grep -E "$listRE" | sed 's/* //')
+print_header "Checking \"$BRANCH_NAME\"..."
 
-printf '\n\033[0;105mChecking "%s"... \033[0m\n', "$BRANCH_NAME"
-
-if echo "$BRANCH_NAME" | grep -q '^(rebase)|(production)*$'; then
- 	printf '\n\033[0;32mNo checks necessary on "%s", pushing now... 🎉\033[0m\n', "$BRANCH_NAME"
+if should_skip_hook; then
+	print_success "No checks necessary on \"$BRANCH_NAME\", pushing now... 🎉"
 	exit 0
 fi
 
+# Identify staged Ruby-related files (including Gemfile/Rakefile) to lint before commit.
 RUBY_FILES="$(git diff --diff-filter=d --name-only --cached | grep -E '(Gemfile|Rakefile|\.(rb|rake|ru))$')"
-
 PRE_STATUS="$(git status | wc -l)"
 
+# Initialise exit code variables to track success (0 = success)
+RUBOCOP_EXIT_CODE=0
 WORK_DONE=0
 
-if [ -n "$RUBY_FILES" ]; then
-  printf '\nRunning Rubocop...'
-  for file in $RUBY_FILES; do
-    git show :"$file" | bundle exec rubocop -A --stdin "$file"
-  done
+if [ -z "$RUBY_FILES" ]; then
+  print_error "There are currently no updated files in \"$BRANCH_NAME\". 🤨"
+else
+  print_warning "Running Rubocop..."
+  # Convert space-separated file list into positional parameters for safe argument passing
+  set -- $RUBY_FILES
+  # Execute RuboCop with auto-fix enabled on the staged files that have been set
+  bundle exec rubocop -a --force-exclusion -- "$@"
+  # Capture the exit code from RuboCop command (0 = success, non-zero = errors)
   RUBOCOP_EXIT_CODE=$?
+  # Flag that linting ran so we can report result and re-add files if needed.
   WORK_DONE=1
-else
-  RUBOCOP_EXIT_CODE=0
 fi
 
 POST_STATUS="$(git status | wc -l)"
 
 if [ ! $RUBOCOP_EXIT_CODE -eq 0 ]; then
   git reset HEAD
-  printf '\n\033[0;31mLinting has unfixable errors; please fix and restage your commit. 😖\033[0m\n'
+  print_error "Linting has uncorrectable errors; please fix and restage your commit. 😖"
   exit 1
 fi
 
 if [ "$PRE_STATUS" != "$POST_STATUS" ]; then
-  git add "$RUBY_FILES" "$ESLINT_FILES" "$PRETTIER_FILES"
+  git add "$RUBY_FILES"
 fi
 
-if [ $WORK_DONE -eq 1 ]; then
-  printf '\n\033[0;32mLinting completed successfully! 🎉\033[0m\n'
+if [ ! $WORK_DONE -eq 0 ]; then
+  print_success "Linting completed successfully! 🎉"
 fi
 
 exit 0

.githooks/pre-push

@@ -1,46 +1,32 @@
-#!/bin/sh
+#!/bin/bash
+# Source common hook utilities
+. "$(dirname "$0")/common.sh"
 
-list="issue spike task"
+# Initialize branch name
+init_branch_name
 
-listRE="^($(printf '%s\n' "$list" | tr ' ' '|'))/"
+print_header "Checking \"$BRANCH_NAME\"..."
 
-BRANCH_NAME=$(git branch --show-current | grep -E "$listRE" | sed 's/* //')
-
-printf '\n\033[0;105mChecking "%s"... \033[0m\n', "$BRANCH_NAME"
-
-if echo "$BRANCH_NAME" | grep -q '^(rebase)|(production)*$'; then
- 	printf '\n\033[0;32mNo checks necessary on "%s", pushing now... 🎉\033[0m\n', "$BRANCH_NAME"
-	exit 0
-fi
-
-# Check for existence of "new or modified" test files
-TEST_FILES="$(git diff --diff-filter=ACDM --name-only --cached | grep -E '(./test/*)$')"
-# Get all test files to run tests
-RUBY_FILES="$(git ls-files | grep -i -E '(_test\.rb)$')"
-
-WORK_DONE=0
-
-if [ -z "$TEST_FILES" ]; then
-  printf 'There are no new tests created in "%s".\n', "$BRANCH_NAME"
-  printf '\n\033[0;31mContinuing without new tests... 😖\033[0m\n'
+# Skip on specific branches, with --no-verify flag, or when amending
+if should_skip_hook; then
+  print_success "Skipping pre-push hook... 🎉"
+  exit 0
 fi
 
-if [ -n "$RUBY_FILES" ]; then
-  printf '\nRunning Unit Tests...'
-  make test
-  RUBY_TEST_EXIT_CODE=$?
-  WORK_DONE=1
+# Check for existence of "new or modified" files
+if ! git update-index -q --ignore-submodules --refresh; then
+	print_warning 'Up-to-date check failed 😖'
+  GEM_BUILD_EXIT_CODE=1
 else
-  RUBY_TEST_EXIT_CODE=0
+  print_success 'Building Gem... '
+  make build
+  GEM_BUILD_EXIT_CODE=$?
 fi
 
-if [ ! $RUBY_TEST_EXIT_CODE -eq 0 ]; then
-  printf '\n\033[0;31mCannot push, tests are failing. Use --no-verify to force push. 😖\033[0m\n'
+if [ $GEM_BUILD_EXIT_CODE -ne 0 ]; then
+  print_error 'Gem build failed. Please check your changes. 😖'
   exit 1
+else
+  print_success 'Gem build succeeded, pushing changes. 🎉'
+  exit 0
 fi
-
-if [ $WORK_DONE = 1 ]; then
-  printf '\n\033[0;32mAll tests are green, pushing... 🎉\033[0m\n'
-fi
-
-exit 0