diff --git a/.github/workflows/housekeeping.yaml b/.github/workflows/housekeeping.yaml index 115507c2c9c..9bd205e61b3 100644 --- a/.github/workflows/housekeeping.yaml +++ b/.github/workflows/housekeeping.yaml @@ -65,10 +65,6 @@ jobs: fi done - - name: run pre-commit checks - continue-on-error: true - uses: pre-commit/action@v2.0.3 - - name: update versions in docs run: | for train in stable incubator; do @@ -92,6 +88,11 @@ jobs: --output-file="app-readme.md" \ --template-files="/home/runner/work/apps/apps/templates/docs/app-readme.md.gotmpl" \ --chart-search-root="${chart}" + helm-docs \ + --ignore-file=".helmdocsignore" \ + --output-file="helm-values.md" \ + --template-files="/home/runner/work/apps/apps/templates/docs/helm-values.md.gotmpl" \ + --chart-search-root="${chart}" fi done done @@ -133,37 +134,11 @@ jobs: pybump bump --file ./charts/${train}/${chart}/Chart.yaml --level patch done - - name: update versions in docs - run: | - for train in stable incubator; do - for chart in charts/${train}/*; do - if [ -d "${chart}" ]; then - maxchartversion=$(cat ${chart}/Chart.yaml | grep "^version: " | awk -F" " '{ print $2 }') - chartname=$(basename ${chart}) - echo "Copying templates to ${chart}" - helm-docs \ - --ignore-file=".helmdocsignore" \ - --output-file="README.md" \ - --template-files="/home/runner/work/apps/apps/templates/docs/README.md.gotmpl" \ - --chart-search-root="${chart}" - helm-docs \ - --ignore-file=".helmdocsignore" \ - --output-file="CONFIG.md" \ - --template-files="/home/runner/work/apps/apps/templates/docs/CONFIG.md.gotmpl" \ - --chart-search-root="${chart}" - helm-docs \ - --ignore-file=".helmdocsignore" \ - --output-file="app-readme.md" \ - --template-files="/home/runner/work/apps/apps/templates/docs/app-readme.md.gotmpl" \ - --chart-search-root="${chart}" - fi - done - done - - - name: rerun pre-commit checks + - name: run pre-commit checks continue-on-error: true uses: pre-commit/action@v2.0.3 + - name: Copy general readme to website run: | yes | cp -rf index.yaml docs/index.yaml || echo "chart-index copy failed, continuing..." @@ -189,6 +164,7 @@ jobs: mkdir -p docs/apps/${train}/${chartname} || echo "app path already exists, continuing..." yes | cp -rf ${chart}/README.md docs/apps/${train}/${chartname}/index.md || echo "readme copy failed, continuing..." yes | cp -rf ${chart}/CONFIG.md docs/apps/${train}/${chartname}/CONFIG.md || echo "config copy failed, continuing..." + yes | cp -rf ${chart}/helm-values.md docs/apps/${train}/${chartname}/helm-values.md || echo "config copy failed, continuing..." yes | cp -rf ${chart}/LICENSE docs/apps/${train}/${chartname}/LICENSE.md || echo "license copy failed, continuing..." sed -i '1s/^/# License
\n\n/' docs/apps/${train}/${chartname}/LICENSE.md || echo "license edit failed, continuing..." fi diff --git a/templates/docs/CONFIG.md.gotmpl b/templates/docs/CONFIG.md.gotmpl index 5e503c64ed5..e7bc05251d7 100644 --- a/templates/docs/CONFIG.md.gotmpl +++ b/templates/docs/CONFIG.md.gotmpl @@ -13,3 +13,5 @@ https://truecharts.org/manual/Quick-Start%20Guides/14-linking-apps/ In the future this page is going to contain an automated list of options available in the installation/edit UI. {{- end -}} {{ template "custom.custom.configuration" . }} + +{{ template "custom.copyright" . }} diff --git a/templates/docs/README.md.gotmpl b/templates/docs/README.md.gotmpl index e73bfc280dc..d1cf1a2f377 100644 --- a/templates/docs/README.md.gotmpl +++ b/templates/docs/README.md.gotmpl @@ -44,15 +44,12 @@ To remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://true - See the [Wiki](https://truecharts.org) - Check our [Discord](https://discord.gg/tVsPTHWTtr) - Open a [issue](https://github.com/truecharts/apps/issues/new/choose) -- Ask a [question](https://github.com/truecharts/apps/discussions) {{- end -}} {{- define "custom.copyright" -}} All Rights Reserved - The TrueCharts Project {{- end -}} {{ template "custom.introheader" . }} -{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} - {{ template "chart.description" . }} {{ template "chart.deprecationWarning" . }} diff --git a/templates/docs/helm-values.gotmpl b/templates/docs/helm-values.gotmpl new file mode 100644 index 00000000000..920610b68e2 --- /dev/null +++ b/templates/docs/helm-values.gotmpl @@ -0,0 +1,22 @@ +{{- define "custom.helm.introheader" -}} +# Default Helm-Values +{{- end -}} +{{- define "custom.helm.notes" -}} +TrueCharts is primarily build to supply TrueNAS SCALE Apps. +However, we also supply all Apps as standard Helm-Charts. In this document we aim to document the default values in our values.yaml file. + +Most of our Apps also consume our "common" Helm Chart. +If this is the case, this means that all values.yaml values are set to the common chart values.yaml by default. This values.yaml file will only contain values that deviate from the common chart. +You will, however, be able to use all values referenced in the common chart here, besides the values listed in this document. +{{- end -}} + +{{- define "custom.helm.copyright" -}} +All Rights Reserved - The TrueCharts Project +{{- end -}} +{{ template "custom.helm.introheader" . }} + +{{ template "custom.helm.notes" . }} + +{{ template "chart.valuesSection" . }} + +{{ template "custom.helm.copyright" . }}