Usage

Generate Helm chart documentation with helm-docs when a chart has a README.md.gotmpl file.

include:
- component: $CI_SERVER_FQDN/xrow-public/ci-tools/helm-docs@stable
  inputs:
    name: my-chart
    path: chart

The component creates build:helm-docs:<name> and publishes the generated chart README.md as an artifact. Use needs when documentation generation must wait for another job, for example Helm linting.

Inputs

Name	Description	Default	Type
---	---	---	---
name	The name of the Helm Chart.	helm	string
needs	The jobs that this job depends on.	[]	array
path	Relative path to the Helm Chart.	chart	string
stage	The name of the stage.	build	string
tags	The runners that this job depends on.	[]	array

Inputs​

Inputs