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.14.2*

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

Download URLs

Version SHA256 Size (KB)
1.14.2 d59c05cfd06e07d685e79f148594cd68a9bc631b985ca8d7fe2f183708337961 2517
1.13.1 76fd3cc15e42de9c9dbedc275cc66137bee284efa60fe77e1683c987c1f54d02 2503
1.13.0 9015ea3dfe9255898961936472ab99e2912aa1574b1a3fe9fba3916385c5c943 2505
1.12.0 58bc3b025686aefbf6d3727712b25b95772a1bfa1ab2c2b57c07a8b6681f5df9 2468
1.11.3 3462e5f013a3d24b7451af4477e2c82517951ffaa36c4d3166b16d79dbe95eaf 2465
Version SHA256 Size (KB)
1.14.2 17aa9ff0a1940e40df2fa05162a3306dde4e283c5d14cd9ce5c6931c1ba122a8 2159
1.13.1 75fa2806b1534aeb564e30da400ec72b6758056b9ba69117ab73aa4d32e90883 2147
1.13.0 1092bf0da3a85e3b56668cf03da1d9db5dc8b25fc620355c91592d2b60bbcd76 2147
1.12.0 4bed4e7ea6149c0155dd35565905c4efb61c03093a25344eb0588f08408fb3df 2117
1.11.3 25514953b2ddbb93413fd05a775d9b04e553fc46ba5ea80a870784c67cdae8a4 2117
Version SHA256 Size (KB)
1.14.2 d63be5216cdb86b1f4fd0dabb33d165c317f44c2622b0530e386cf871f3bfb6b 2120
1.13.1 13c654fe0e15eb8f5fc51e8a9bd35dd46e2cbdc2db5c09d03772d3b331900884 2109
1.13.0 04132b18c8062c6342ee60231ee4abcec6263571abf8782190c25fefb1d4aa88 2110
1.12.0 8c3acc25f1886c8b39b18b8a85c75225d3070a21eea24e1e409a45e701cd3717 2095
1.11.3 0612cc3712ef9335ad6a07372ccc7ed841ec43311808acc9a758d7c2f9967620 2091

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.3
    - 1.12.0
    - 1.13.0
    - 1.13.1
    - 1.14.2
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: arm7
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.3/helm-docs_1.11.3_Linux_arm64.tar.gz
  sha256: 24b6734a8f979bc7674195e306c5dd9ffa62113fed86f2ce407fcd29013cfd2f
  timestamp: 2023-10-13 11:42:47+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.11.3/helm-docs_1.11.3_Linux_arm7.tar.gz
  sha256: 2726a9bbe187fdf4466dded7b5b0b6c6e3e9fc8eeec630252c0c9e82048875c9
  timestamp: 2023-10-13 11:42:47+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.11.3/helm-docs_1.11.3_Linux_x86_64.tar.gz
  sha256: 07efe78fd56de173e29f15ea5be2aa6f425d346bcd480aa229840b5405661cb2
  timestamp: 2023-10-13 11:42:47+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-10-13 11:44:33+00:00
- 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-10-13 11:44:33+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.12.0/helm-docs_1.12.0_Linux_arm64.tar.gz
  sha256: bbcb514f7b48ddaa930339f15682e7abb6af66cd6773dd8fd564cbacf5d8cd94
  timestamp: 2023-12-21 12:32:24+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.12.0/helm-docs_1.12.0_Linux_arm7.tar.gz
  sha256: 834d372ba007601cff1407e2ad6ec2eca55b3ea063bc9e6941eda97c3053c698
  timestamp: 2023-12-21 12:32:24+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.12.0/helm-docs_1.12.0_Linux_x86_64.tar.gz
  sha256: f0a9f105de7b1c07e19f3ececa52e3a5a270ffe39b744cdce1a26bea34025abf
  timestamp: 2023-12-21 12:32:24+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.13.0/helm-docs_1.13.0_Linux_arm64.tar.gz
  sha256: 8cfffc0339c91486e1b8afd4f1bd83cc3fa9cccb5721750f835c731a3615ba1f
  timestamp: 2024-02-24 15:05:18+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.13.0/helm-docs_1.13.0_Linux_arm7.tar.gz
  sha256: d061c5a16eba695c0856cdd852ceec4d408b5bfd1da4881440aacabe2a98067e
  timestamp: 2024-02-24 15:05:18+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.13.0/helm-docs_1.13.0_Linux_x86_64.tar.gz
  sha256: fc5e6cd5d44efa5a40ae4874e261e5ee200119e379291582cc4c9303abb1a5fe
  timestamp: 2024-02-24 15:05:18+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.13.1/helm-docs_1.13.1_Linux_arm64.tar.gz
  sha256: 4dfa9fe4f069ce5975b772ee4f43416316a6e579b1574bd640be460f553c3f71
  timestamp: 2024-03-02 15:05:28+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.13.1/helm-docs_1.13.1_Linux_arm7.tar.gz
  sha256: 0f6c66586c3fd4e8da2a49d69a3de07107fd8c7296249da6f6e6cee2d00abb12
  timestamp: 2024-03-02 15:05:28+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.13.1/helm-docs_1.13.1_Linux_x86_64.tar.gz
  sha256: df8d803506933ceb92bc2996d8a432059a35fc19a308ac37a141971ffdf7aa33
  timestamp: 2024-03-02 15:05:28+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.14.2/helm-docs_1.14.2_Linux_arm64.tar.gz
  sha256: c3787212332386dcd122debef7848feb165aa701467ae3e3442df7638f3ac4e4
  timestamp: 2024-07-09 09:06:44+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.14.2/helm-docs_1.14.2_Linux_arm7.tar.gz
  sha256: cd2e066c555f6f4f9d47dcf80c39dfcca9691a171cbb4801a356711399e52ce5
  timestamp: 2024-07-09 09:06:44+00:00
- url: https://github.com/norwoodj/helm-docs/releases/download/v1.14.2/helm-docs_1.14.2_Linux_x86_64.tar.gz
  sha256: a8cf72ada34fad93285ba2a452b38bdc5bd52cc9a571236244ec31022928d6cc
  timestamp: 2024-07-09 09:06:44+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