Iain Sproat
b1cbd05683
* fix(helm): update documentation to match helm chart * fix(helm): update documentation should not update README in helm repository * fix(helm): should ensure output schema conforms to prettier requirements * feat(pre-commit): update helm documentation as part of pre-commit * feat(circleci): update Helm README when publishing new Helm chart * fix(pre-commit): need to npm install before using readme generator
43 lines
1.4 KiB
Bash
Executable File
43 lines
1.4 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
if ! command -v node &> /dev/null
|
|
then
|
|
echo "🛑 node could not be found. Please install node (and ensure it is in your PATH) before trying again."
|
|
exit 1
|
|
fi
|
|
|
|
if ! command -v git &> /dev/null
|
|
then
|
|
echo "🛑 git could not be found. Please install git (and ensure it is in your PATH) before trying again."
|
|
exit 1
|
|
fi
|
|
|
|
GIT_ROOT="$(git rev-parse --show-toplevel)"
|
|
|
|
README_GENERATOR_DIR="${GIT_ROOT}/../readme-generator-for-helm"
|
|
|
|
JSON_SCHEMA_PATH="${GIT_ROOT}/utils/helm/speckle-server/values.schema.json"
|
|
|
|
if [ ! -d "${README_GENERATOR_DIR}" ]; then
|
|
echo "🔭 Could not find readme-generator-for-helm in a sibling directory to speckle-server"
|
|
echo "👩👩👧👧 Proceeding with cloning readme-generator-for-helm to a sibling directory, readme-generator-for-helm"
|
|
git clone git@github.com:bitnami-labs/readme-generator-for-helm.git "${README_GENERATOR_DIR}"
|
|
fi
|
|
|
|
pushd "${README_GENERATOR_DIR}"
|
|
echo "✨ Updating to the latest version of readme-generator-for-helm"
|
|
git switch main
|
|
git pull origin main
|
|
npm install
|
|
popd
|
|
|
|
pushd "${GIT_ROOT}"
|
|
echo "🏗 Generating the documentation"
|
|
node "${README_GENERATOR_DIR}/bin/index.js" \
|
|
--config "${GIT_ROOT}/utils/helm/.helm-readme-configuration.json" \
|
|
--values "${GIT_ROOT}/utils/helm/speckle-server/values.yaml" \
|
|
--schema "${JSON_SCHEMA_PATH}"
|
|
|
|
yarn prettier:fix:file "${JSON_SCHEMA_PATH}"
|
|
popd
|