Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2026-02-08 15:46:54 +01:00
Code Issues Packages Projects Releases Activity

Fix helm documentation generation

Browse Source
This commit is contained in:
Sebastian Sdorra
2021-08-11 11:17:38 +02:00
parent fe6235f4da
commit 928439b4d5
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
scm-packaging/helm/src/main/chart/values.yaml
View File

@@ -34,7 +34,7 @@ image:
# image.pullPolicy -- SCM-Manager image pull policy
pullPolicy: IfNotPresent
# image.pullSecret -- Secret with credentials for the image registry
# pullSecret: registry-credentials
pullSecret: ""
# nameOverride -- Override the resource name prefix
nameOverride: ""

11
scm-packaging/helm/src/main/docs/docs.sh
View File

@@ -29,8 +29,11 @@ IFS=$'\n\t'
if helm-docs --version > /dev/null 2>&1; then
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
MODULE_DIR="$( cd "${SCRIPT_DIR}/../../../" >/dev/null 2>&1 && pwd )"
CHARTDIR="${MODULE_DIR}/build/helm/charts/scm-manager"
PAGE="docs/en/installation/k8s.md"
TEMPLATE="${MODULE_DIR}/src/main/docs/helm.md.gotmpl"
README="${MODULE_DIR}/../../${PAGE}"
CHARTDIR="${MODULE_DIR}/target/chart"
if [ ! -d "${CHARTDIR}" ]; then
echo "chart directory ${CHARTDIR} does not exists"
echo "please run maven package before"
@@ -39,9 +42,9 @@ if helm-docs --version > /dev/null 2>&1; then
fi
cd "${CHARTDIR}"
PAGE="docs/en/installation/k8s.md"
echo helm-docs --template-files="${MODULE_DIR}/src/main/docs/helm.md.gotmpl" --output-file="${MODULE_DIR}/../../${PAGE}"
helm-docs --template-files="../../src/main/docs/helm.md.gotmpl" --output-file="../../../../${PAGE}"
helm-docs -t "${MODULE_DIR}/src/main/docs/helm.md.gotmpl" -l trace
cp "${CHARTDIR}/README.md" "${README}"
echo "The helm documentation was successfully generated"
echo "Please check the results at ${PAGE}"
echo "And don't forget to commit ;)"