helm-docs
A tool for automatically generating markdown documentation for helm charts
GPL-3.0 License
Bot releases are visible (Hide)
Published by norwoodj about 4 years ago
Changelog
491d5d9 chore: updates readmes with latest version of helm-docs
8bb2011 fix: makes it so charts with empty values files still get helm-docs-version footers
Docker images
docker pull jnorwood/helm-docs:latestdocker pull jnorwood/helm-docs:v1.2.1
Published by norwoodj about 4 years ago
Changelog
a43ccae Merge pull request #54 from DirtyCajunRice/master
31983b5 Merge pull request #61 from norwoodj/fix-dash-versions
cbf9096 Merge pull request #62 from norwoodj/fix-diry
0dc6df7 Merge pull request #63 from norwoodj/add-helm-docs-version-line
b77e783 allow multiple templates
21c7bae chore: updates pre-commit hook version
670be38 feat: updates default chart to add a footer to markdown files with the helm-docs version, if set
02f4425 feat: updates to add chart search path flag and to search for template files differently based on how they're presented fixes #47
4ad6c82 fix: escapes dashes in version badges so complicated versions work fixes #56
Docker images
docker pull jnorwood/helm-docs:latestdocker pull jnorwood/helm-docs:v1.2.0
Published by norwoodj about 4 years ago
Changelog
f83a5b5 Merge pull request #60 from norwoodj/new-style-comment-parity
d88cca4 feat: Largely expands all features for old comments to new comments, old-style comments effectively deprecated
Docker images
docker pull jnorwood/helm-docs:latestdocker pull jnorwood/helm-docs:v1.1.0
Published by norwoodj about 4 years ago
Changelog
52f4bc6 Merge pull request #59 from norwoodj/auto-find-comments
4634ab3 feat!: Adds the capability to provide comments without the path to the documented field fixes #58
Docker images
docker pull jnorwood/helm-docs:latestdocker pull jnorwood/helm-docs:v1.0.0
Published by norwoodj about 4 years ago
Changelog
b6ff99b Merge pull request #50 from sc250024/fix-GithubRelease
26112f1 fix: GitHub token for Homebrew tap
Docker images
docker pull jnorwood/helm-docs:latestdocker pull jnorwood/helm-docs:v0.15.0
Published by github-actions[bot] about 4 years ago
Changelog
ef2c57d Add FPM/DEB packaging method, sign checksums
2eb5ddd Add Github Actions CI/CD workflows
2aefc00 Improve Docker usage documentation
99c522e Merge pull request #1 from Artus-LHIND/develop
2db2ba7 Merge pull request #2 from Artus-LHIND/develop
582154e Merge pull request #3 from Artus-LHIND/develop
0e25e47 Merge pull request #4 from Artus-LHIND/develop
b24995e Merge pull request #40 from ccremer/patch-1
a2c4222 Merge pull request #41 from ccremer/actions
f66fdbd Merge pull request #42 from Artus-LHIND/master
2ddaac8 Merge pull request #43 from acim/install-from-source
b6e6c48 Merge pull request #46 from matheusfm/feature/name-template
3cfab7a Merge pull request #49 from sc250024/fix-PreCommitHookReadmeTemplate
4e48985 add 'chart.name' template description in 'Available Templates' section
8437377 add chart name template to examples
d3f1be7 add doc how to install from source
5cfba29 add template to the chart name
722e89a chore: update default template in README.md
feaeece feat: add full-template example
8fb6f38 feat: add two regex for markdown linting
64ad9ea feat: check for line templates, update README.md
77673fb feat: deprecation, badges, styling, more options
61d5caf feat: fixed and updated READMEs
1af69cd feat: updates signature public key for action
f67f99d fix: Updating hook config for README.md.gotmpl
b3a41ff fix: no double whitespace using the badges
1ee9a7e refactor: badges at default template
Docker images
docker pull jnorwood/helm-docs:latestdocker pull jnorwood/helm-docs:v0.14.0
Published by norwoodj over 4 years ago
Changelog
1d599a9 Add WORKDIR to Dockerfile to allow mounting charts, expand docs
a025f54 Merge pull request #38 from nvtkaszpir/dockerfile-workdir
Docker images
docker pull jnorwood/helm-docs:latestdocker pull jnorwood/helm-docs:v0.13.0
Published by norwoodj over 4 years ago
Changelog
0e6e33d Merge pull request #36 from eddycharly/master
946e126 attempt to add docker to goreleaser
effae03 fix: fixes docker image name
Docker images
docker pull jnorwood/helm-docs:latestdocker pull jnorwood/helm-docs:v0.12.0
Published by norwoodj over 4 years ago
Changelog
49ce04b Merge pull request #34 from norwoodj/update-custom-default-rendering
a792182 fix: Doesn't backtick-quote custom default values, back to the way originally implemented
Published by norwoodj over 4 years ago
Changelog
6e7dd6d Merge pull request #31 from norwoodj/improve-custom-default-rendering
1923cc6 Merge pull request #32 from norwoodj/issue-24-special
0e09ed3 Merge pull request #33 from norwoodj/issue-28-output
2e9de7c chore: slightly changes format of @default values as they're rendered in the mardown output
37501cb feat: adds a --output-file cli option for specifying the file to which documentation is written (fixes #28)
0e8e6fd fix: renders <, >, and & characters from default values correctly (fixes #24)
Published by norwoodj over 4 years ago
Changelog
3c4fdb2 Merge pull request #29 from eddycharly/master
30bbb44 add comments continuation and default value
Published by norwoodj almost 5 years ago
Changelog
a1a224e Added Type field & dependencies compatibilty for Helm 3 v2 API
0b03dcb Merge pull request #23 from skaro13/feature/helm-3-compatibility
57aeb0f Updated Build Var Name
Published by norwoodj about 5 years ago
Changelog
e08b97e Merge pull request #19 from norwoodj/minor-fixes
33f87b1 fix: cleans up some code and minor fix to ignore case
Published by norwoodj about 5 years ago
Changelog
56bad9e Feature => Pre-commit hook (#14)
a705e76 Merge pull request #16 from norwoodj/fix-chart-links
bddbcfe Merge pull request #17 from norwoodj/git-hook-changes
c8635e6 Merge pull request #18 from norwoodj/improve-ignoring
99f737f feat: changes files for git hook slightly
d6aca61 feat: improves ignore feature, accepting an ignore file at the root of the repository as well as in the directory
a16a110 feat: updates links to source in chart files
Published by norwoodj about 5 years ago
Changelog
3eff51f Merge pull request #11 from norwoodj/add-goreport
14ff149 Merge pull request #15 from norwoodj/add-ignore-file
8786369 feat: adds goreport to the readme
68966e5 feat: adds support for an ignore file to exclude charts from processing
Published by norwoodj about 5 years ago
Changelog
cc61258 Merge pull request #10 from norwoodj/document-lists-and-objects
3ccb4ed feat: updates values table generation allowing for non-empty lists/maps to be documented
Published by norwoodj over 5 years ago
Changelog
5d75e92 feat: updates documentation with homebrew installation instructions
Published by norwoodj over 5 years ago
Changelog
dea5d67 Merge pull request #7 from norwoodj/homebrew-6
4e79480 feat: adds goreleaser configuration to deploy a homebrew tap
Published by norwoodj over 5 years ago
Changelog
c9c4752 Merge pull request #5 from norwoodj/issue-3
ed53371 chore: removes unnecessary log message
2a1c431 feat: refactor to use gotemplates to render documentation, adds new example charts
Published by norwoodj over 5 years ago
Changelog
5847981 fix: updates name of version var to get a version in the CLI flag