Skip to content
This repository has been archived by the owner on Aug 7, 2024. It is now read-only.

Latest commit

 

History

History
37 lines (26 loc) · 1.36 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.36 KB

Deprecated Project Notice

⚠️ This project is deprecated! Charts will no longer be updated

wadtfy-custom-components

Contains a set of custom Crossplane components used in the WADTFY ecosystem.

Add the charts by executing the following commands:

helm repo add wadtfy-custom-components https://dvpe-cloud.github.io/wadtfy-custom-components
helm repo update

How to release a new Helm Chart?

Each chart's README.md is generated via helm-docs.

  1. Update the documentation:
    Edit (or create) theREADME.md.gotmpl file in the chart's folder and add your documentation like this:
    {{/* Header and Version Badge */}}
    {{ template "chart.header" . }} 
    {{ template "chart.versionBadge" . }}
    
    {{ template "chart.description" . }}
    {{/* Here you can add your documentation text */}}
    
    {{/* Don't change the last lines from here on which generate a table from values.yaml */}}
    ## Chart Configuration Parameters
    The following table lists the configurable parameters of the chart and its default values.
    
    {{ template "chart.valuesSection" . }}
    
  2. Run helm-docs inside the chart's folder to generate the README.md file
  3. Increase version in Chart.yaml. Each merge to master is validated via GitHub Actions. If the version is not updated, the merge is not permitted.