helm-docs.sh

#!/usr/bin/env bash

set -euo pipefail

SCRIPTPATH=$(dirname "$0")
README_GENERATOR_VERSION="2.6.0"
README_GENERATOR_EXE="readme-generator"

if ! hash "${README_GENERATOR_EXE}" 2>/dev/null; then
  echo >&2 "readme-generator not installed. Installing..."
  hash npm 2>/dev/null || { echo >&2 "npm is required to install ${README_GENERATOR_EXE}. Please install npm and rerun the script. Aborting."; exit 1; }
  # platform agnostic npm install, also adds into the path
  npm install -g "@bitnami/readme-generator-for-helm@${README_GENERATOR_VERSION}"
fi

# generate docs and show the diff
mapfile -t chart_paths < <(find "$SCRIPTPATH/charts" -type f -iname "Chart.yaml" -exec dirname {} +)
for cpath in "${chart_paths[@]}"
do
  echo >&2 "Generating Chart documentation for ${cpath}…"
  readme-generator --values="${cpath}/values.yaml" --readme="${cpath}/README.md"
done
git diff --exit-code