Creating Hotfixes

This page is a guide overviewing how to create and push hotfixes for the Rhino Hotfix (opens in a new tab) utility.

Built-in Variables

Standards

Hotfix scripts should conform to the following standards:

Bash Shebang

The top of the script should always start with an env bash shebang:

#!/usr/bin/env bash

Hotfix Function

All script actions should be contained within functions, with the main function always called hotfix:

hotfix() {
  echo "This is a hotfix."
}

Localize Everything

All variables should be localized within the functions:

hotfix() {
  local names=("test1" "test2")
 
  for i in "${names[@]}"; do
    echo "${i}"
  done
}

Cleanup Extra Functions

If using extra functions, be sure to clean them up with unset -f at the end of the hotfix function:

hotfix() {
  local names=("test1" "test2")
 
  for i in "${names[@]}"; do
    subprocess "${i}"
  done
  unset -f subprocess
}
 
subprocess() {
  echo "${1}"
}

Example Script

Putting it all together, here is what a hotfix script might look like:

#!/usr/bin/env bash
 
hotfix() {
  local names messages
  names=("test1" "test2")
  messages=("This is the first message" "This is the second")
 
  for i in "${!names[@]}"; do
    subprocess "${names[i]}" "${messages[i]}"
  done
  unset -f subprocess
}
 
subprocess() {
  local name="${1}" message="${2}"
  echo "${name}: ${message}"
}

Adding and Publishing

Once written, the hotfix script must follow these guidelines:

1. It must be placed in the scripts/ directory of the Rhino Hotfix (opens in a new tab) repository.
2. While the name of the script can be flexible, it must be relevant to the thing it is fixing.
3. The name of the script must end with the suffix .sh.

Then, from the head of the repository, run:

go run manager.go add -t HOTFIXNAME -d "Some description" -s scripts/SCRIPTNAME.sh
git add hotfixes.json scripts/SCRIPTNAME.sh