helm-docs

A tool for automatically generating markdown documentation for helm charts

GPL-3.0 License

Downloads
86
Stars
1.4K
Committers
47

Bot releases are visible (Hide)

helm-docs - v1.14.2 Latest Release

Published by norwoodj 4 months ago

Changelog

  • 37d3055 Release v1.14.2
helm-docs - v1.14.1

Published by norwoodj 4 months ago

Changelog

  • 21ccd56 Release 1.14.1
helm-docs - v1.14.0

Published by norwoodj 4 months ago

Changelog

  • 4aa79f6 Release 1.14.0
helm-docs - 1.14.0

Published by norwoodj 4 months ago

Changelog

  • 4aa79f6 Release 1.14.0
helm-docs - v1.13.1

Published by norwoodj 8 months ago

Changelog

  • a66bb9c Release v1.13.1
helm-docs - v1.13.0

Published by norwoodj 8 months ago

Changelog

  • 6cdd5ff Release v1.13.0
helm-docs - v1.12.0

Published by norwoodj 10 months ago

Changelog

  • 604ab7f Add Tests for section feature
  • 4855aef Add containerized pre-commit hook
  • 94cc6af Add possibility to generate subsectioned Values Tables
  • 84eb04f Add some comments about parsing of key comments
  • 0b4b180 Adds AsMap to iterate over .Files.Glob
  • 60d02b1 Change example section chart to new templates
  • 5145fd6 Copy NotationType in Nil Values
  • 7d54b35 Factor out sorting value rows and add dedicated default section
  • 46cac39 Fix filename
  • 980715e Give an example of how to use sections
  • 3b87f0a Merge pull request #159 from terrycain/files_asmap
  • 2743ca4 Merge pull request #167 from RetGal/patch-1
  • aa99dee Merge pull request #172 from gianklug/patch-1
  • 4816ed5 Merge pull request #184 from sblundy/notation-on-null-values
  • eadcfd7 Merge pull request #191 from Labelbox/add-docker-to-pre-commit-hooks
  • e9aaa42 Merge pull request #194 from Haepaxlog/sections
  • 65f1d83 Pin container version to tagged release v1.11.0
  • 65f2b92 Put the creation and sorting of sectioned Value Rows in its own functions
  • d1a32aa Sectioned values are default if provied
  • 5327bfc Update .pre-commit-hooks.yaml
  • c143157 Update README.md with pre-commit usage examples
  • 75774f5 conform to MD022
  • eb95c9d fix(README): change the way helm-docs is installed
helm-docs - v1.11.3

Published by norwoodj about 1 year ago

Changelog

  • 598d9b5 Bump all available dependencies to latest.
  • 4120230 Merge pull request #198 from brettmorien/master
  • e67186b Merge pull request #199 from norwoodj/feat/improving-community-standards
  • dd3d586 Merge pull request #201 from Nepo26/200-bug-binary-artifacts-renamed-in-v1112
  • d38ede8 fix: changed to always get the latest version on the helm docs pre commit
  • a808d6e fix: correct contributing link referent in pr template
  • cdc1557 hotfix: changing back artifacts name
helm-docs - v1.11.2

Published by norwoodj about 1 year ago

Changelog

  • 2b0ca58 Revert "fix: String additional empty line from generated README.md"
  • b14e524 chore: adding todo to refactor main test
  • 913cc49 chore: change readme to trigger ci
  • 36712d5 chore: update github actions to be able to reproduce using act
  • 3f2182a fix: remove var env dependency by moving tests
  • d0e53ef fix: removing goreleaser project env var to be able to test locally
helm-docs - v1.11.0

Published by norwoodj over 2 years ago

Changelog

  • 817af5c Add an option to list charts to generate
  • 1bf1fee Add option for ignoring values
  • b556d85 Added Helm .Files
  • 4a3acbe Added file lazy loading
  • 39f98ee Improve code according to mjpitz suggestions
  • acef4fd Merge pull request #139 from terrycain/107-files
  • 935a760 Merge pull request #141 from j-buczak/ignoring_values
  • 43632a0 Merge pull request #142 from j-buczak/rename_section_to_raw
  • 20b701f Merge pull request #145 from j-buczak/charts_to_generate_flag
  • bad11a7 Merge pull request #146 from j-buczak/fix_file_sorter
  • 60d8310 Merge pull request #151 from armosec/master
  • e911c77 Rename @section to @raw
  • a5a2be9 adding ignore-non-descriptions flag
  • 72e085f chore: generate READMEs for example charts with new version
  • c64450c fix broken file sorting
  • 45f63df fix: fixes file operations to work when not running from the chart root and fixes several tests
helm-docs - v1.10.0

Published by norwoodj over 2 years ago

Changelog

  • d2cc641 Add support for custom notation type
  • 4b55b9e Generated example charts with new version
  • 88016b1 Merge pull request #140 from norwoodj/fix/nil-value-types
  • ef73e2e Merge pull request #87 from lucernae/notation-type
  • 93aef0b fix: types on nil values
helm-docs - v1.9.1

Published by norwoodj over 2 years ago

Changelog

  • 814c3a1 Generated example charts with new version
  • 02caaaf Revert "Add angle brackets around urls in requirementsTable"
helm-docs - v1.9.0

Published by norwoodj over 2 years ago

Changelog

  • ea66ad2 Add angle brackets around urls in requirementsTable
  • 0b4f3ce Fix documented globals prefixed with the sub-chart alias
  • fa4d751 Fix issue where an empty global object in a child chart would be listed in the root docs
  • 902641c Merge pull request #112 from armsnyder/umbrella-values
  • 361c7d0 Merge pull request #134 from vladimir-babichev/no-bare-urls-in-requirements-table
  • 435f142 Merge pull request #136 from norwoodj/pr-124
  • 3d463f7 New flag --document-dependency-values
  • a126ae1 Runs newest helm-docs to update docs for example charts
  • cae8f4b Tolerate dependency charts without values.yaml
  • b16bef4 Updates alpine docker image to fix issue #124
  • 1785bfb Warn about remote dependencies without erroring; Parse local file:// repositories
helm-docs - v1.8.1

Published by norwoodj over 2 years ago

Changelog

  • e91c4c3 Don't print angle brackets for URL/email if not present
helm-docs - v1.8.0

Published by norwoodj over 2 years ago

Changelog

  • 18004fe Add option for a values file named other than values.yaml.
  • 98700d9 Avoid raw URLs in maintainer tables
  • 372c61e Merge branch 'master' into badge-style
  • 381fc93 Merge pull request #102 from dfarrell07/no_raw_url
  • 6754e5a Merge pull request #121 from dirien/badge-style
  • 76c2280 Merge pull request #130 from maybolt/values-file-option-argument
  • 113c8ed Merge pull request #132 from norwoodj/jnorwood/fix/131
  • ca7f709 Updgrades golang/x/sys to fix #131
  • 7b58ea4 Updgrades sprig to v3
  • fa0ab6f feat: make the badge style from shields.io configurable
helm-docs - v1.6.0

Published by norwoodj almost 3 years ago

Changelog

  • f8ce290 Add a benchmark
  • 47c58c1 Add breaking test for default template loading
  • 97fd7ee Add test for template loading
  • 8abd6f4 Consider only the last group of comments starting with '# --'.
  • 23e694d Do not stop loading templates when a file cannot be found
  • fe5140e Extend README Installation section with scoop alternative for Windows
  • c8fb193 Fix typo in readme
  • dbb16fa Fix typo: serach -> search
  • 5ddabba Ignore comment nodes not containing '# --'.
  • 8103602 Merge pull request #104 from kd7lxl/fix-empty
  • 4669411 Merge pull request #113 from armsnyder/benchmark
  • 2a8b9cc Merge pull request #114 from jrottenberg/pre-commit.com-559
  • f7c7cff Merge pull request #79 from sagikazarmark/fix-77
  • ca888f2 Merge pull request #80 from sagikazarmark/fix-typo
  • d7dc942 Merge pull request #81 from alexrashed/bugfix/default-for-nil
  • 38548f3 Merge pull request #83 from stretched/typo-fix
  • 7c817a8 Merge pull request #85 from jsoref/spelling
  • 2e443ae Merge pull request #93 from goostleek/patch-1
  • 023fece Merge pull request #95 from sc250024/chore-GoReleaserM1
  • 1d44345 Merge pull request #99 from bmcustodio/bmcustodio-fix-comments
  • e49509a No jump required
  • c7a0907 chore: runs newest helm-docs version against example charts
  • 69f296d ci(github): updating actions for apple silicon builds
  • da7d52e ci(github): updating for docker multi-arch builds
  • e396289 ci(goreleaser): updating for docker multi-arch builds
  • c4a8cb7 ci(goreleaser): updating linux package naming for consistency
  • ff46788 ci: add job for importing GPG private key (#122)
  • 9815973 ci: fix environment variable reference
  • 6f70de8 fix type definition when description is empty
  • a77f2e1 fix: fixes @default for variables without value
  • aaec4ec fix: makes description appear even if unrelated comment appears before description comment fixes #92
  • 40f1dcf fix: updates signing key so release builds can work again
  • 384770d remove deprecated goreleaser use_buildx option
  • 593133b spelling: equivalently
  • def0dbd spelling: search
  • 877cfc3 wip
helm-docs - v1.7.0

Published by norwoodj almost 3 years ago

Changelog

  • f8ce290 Add a benchmark
  • 8abd6f4 Consider only the last group of comments starting with '# --'.
  • 5ddabba Ignore comment nodes not containing '# --'.
  • 8103602 Merge pull request #104 from kd7lxl/fix-empty
  • 4669411 Merge pull request #113 from armsnyder/benchmark
  • 2a8b9cc Merge pull request #114 from jrottenberg/pre-commit.com-559
  • 1d44345 Merge pull request #99 from bmcustodio/bmcustodio-fix-comments
  • e49509a No jump required
  • ff46788 ci: add job for importing GPG private key (#122)
  • 9815973 ci: fix environment variable reference
  • 6f70de8 fix type definition when description is empty
  • 40f1dcf fix: updates signing key so release builds can work again
  • 384770d remove deprecated goreleaser use_buildx option
  • 877cfc3 wip
helm-docs - v1.5.0

Published by norwoodj almost 4 years ago

Changelog

6f79fac Add badgesSection template
2e20ce4 Merge pull request #69 from horacimacias/master
81bf0c9 Merge pull request #75 from sagikazarmark/add-badges-section
7c4ae94 Merge pull request #76 from sagikazarmark/fix-set-env
205c7bb Parse requirement's alias and display "alias(name)" if 'alias' was defined
e8bea34 Update full-template example
23c8b5e Update setup-go action
3be86db Update the default template to use badgesSection
b28efd0 Upgrade go version
e65dfab fix: fixes broken comment parsing on values files with dos line endings
ec63edc fix: fixes small formatting issue

Docker images

  • docker pull jnorwood/helm-docs:latest
  • docker pull jnorwood/helm-docs:v1.5.0
helm-docs - v1.4.0

Published by norwoodj about 4 years ago

Changelog

45f5111 Merge pull request #65 from norwoodj/rb/use-file-order
561b946 Merge pull request #66 from sc250024/issue-51
4736f76 chore(goreleaser): fixing brew github deprecation
2bf6418 chore: updates charts with new helm-docs version
6e0311d fix(goreleaser): adding more os and arch types

Docker images

  • docker pull jnorwood/helm-docs:latest
  • docker pull jnorwood/helm-docs:v1.4.0
helm-docs - v1.3.0

Published by norwoodj about 4 years ago

Changelog

4b2522d change flag
4687363 Merge pull request #64 from norwoodj/jnorwood/comprehensive-example
97168d4 chore: updates readmes with latest version of helm-docs
de4bf77 feat: add support for sorting based on presence in file
4acbc68 feat: adds a new chart with good examples, cleans up README a bit more, and shhhh... fixes a bug
445a511 fix: fixes tests by calling correct method
adb421c fix: link to hashbash
3dd414c fix: small issue in sorting by file location

Docker images

  • docker pull jnorwood/helm-docs:latest
  • docker pull jnorwood/helm-docs:v1.3.0