Skip to content

helm-docs

Tool for automatically generating markdown documentation for helm charts

Auto-generates documentation from helm charts into markdown files. the resulting files contain metadata about their respective chart and a table with each of the chart's values, their defaults, and an optional description parsed from comments.

devops

https://github.com/norwoodj/helm-docs

amd64 arm64 armhf

Installation

1. Add WakeMeOps repository

curl -sSL https://raw.githubusercontent.com/upciti/wakemeops/main/assets/install_repository | sudo bash

2. Install helm-docs

sudo apt install helm-docs

Snippets

FROM wakemeops/minideb:bullseye

RUN install_packages \
    helm-docs=1.11.0*

USER 1001

- name: Install dependencies
  uses: upciti/wakemeops-action@v1
  with:
    packages: |
      helm-docs=1.11.0*

Download URLs

Version SHA256 Size (KB)
1.11.0 1bd4e8eb04e4f1bcb9dfb0fde92646b0016d33a4e1844a73e18dfc2daabceeb0 2141
Version SHA256 Size (KB)
1.11.0 1bd817618922ce118a0303af356a0bc845db7e99af6eef1d4a5d1a3adbf4cedd 1838
Version SHA256 Size (KB)
1.11.0 063d0f1b57f7df7c6353c89c82c924336b6b386dff687706a1a4fbabeb4aeb1b 1828

Blueprints

Debian packages listed on this page are generated from op2deb YAML blueprints. Blueprints for helm-docs are versioned here.

Click here to see helm-docs ops2deb blueprints
https://github.com/upciti/wakemeops/blob/main/blueprints/devops/helm-docs/ops2deb.yml
name: helm-docs
matrix:
  architectures:
    - amd64
    - arm64
    - armhf
  versions:
    - 1.11.0
homepage: https://github.com/norwoodj/helm-docs
summary: tool for automatically generating markdown documentation for helm charts
description: |-
  Auto-generates documentation from helm charts into markdown files.
  the resulting files contain metadata about their respective chart and a table
  with each of the chart's values, their defaults, and an optional description
  parsed from comments.
fetch:
  url: https://github.com/norwoodj/helm-docs/releases/download/v{{version}}/helm-docs_{{version}}_Linux_{{target}}.tar.gz
  targets:
    amd64: x86_64
    armhf: armv7
install:
  - helm-docs:/usr/bin/helm-docs

The blueprint fetch keyword contains a URL template pointing to helm-docs releases. Downloaded files are locked in a lockfile versioned here.

Click here to see helm-docs release hashes
https://github.com/upciti/wakemeops/blob/main/blueprints/devops/helm-docs/ops2deb.lock.yml
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.11.0/helm-docs_1.11.0_Linux_x86_64.tar.gz
  sha256: 9fc7bc15b55aea3025cd21f9d4e1384d1538beec5f7090cc0b7c45857cad3e57
  timestamp: 2023-04-11 07:35:21+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.11.0/helm-docs_1.11.0_Linux_arm64.tar.gz
  sha256: 1f8e4593f23067d53a37c44086763395b7abf8e1694939cabaa28b074ee057b7
  timestamp: 2023-04-11 07:37:32+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.11.0/helm-docs_1.11.0_Linux_armv7.tar.gz
  sha256: 59a7929b544c35200dff65ef0793346747c87f0e15f428531652a6c0c5f69d60
  timestamp: 2023-04-11 07:37:32+00:00

Badge

WakeMeOps

[![WakeMeOps](https://docs.wakemeops.com/badges/helm-docs.svg)](https://docs.wakemeops.com/packages/helm-docs)

<a href="https://docs.wakemeops.com/packages/helm-docs">
  <img src="https://docs.wakemeops.com/badges/helm-docs.svg"/>
</a>

.. image:: https://docs.wakemeops.com/badges/helm-docs.svg
:target: https://docs.wakemeops.com/packages/helm-docs