File helm-docs-1.11.1.obscpio of Package helm-docs

Overview Repositories Revisions Requests Users Attributes Meta

File helm-docs-1.11.1.obscpio of Package helm-docs (Revision b3f3c3e9c69620f1de4009d12cdfa24e)

Currently displaying revision b3f3c3e9c69620f1de4009d12cdfa24e , Show latest

07070100000000000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000001900000000helm-docs-1.11.1/.github07070100000001000081A400000000000000000000000164C03CE4000006B1000000000000000000000000000000000000002700000000helm-docs-1.11.1/.github/signature.asc-----BEGIN PGP PUBLIC KEY BLOCK-----

mQENBF8sdg4BCACcJMhLU1lzSYtjApDungY6o4YRwAUjtCvtCnBlVrp4hXw36S/j
AIk5i5B1Tw01hg283JgygJufAIYhTTHfbk+DqQ16ds+xEupGhbS2P6wYKMvmZUTn
W6K3IZndeGJ1kAiVLDf4b19r/EqBxgS8ZrSSPkm8ikaYsv4sFR/9pvs+Lm9tOt7R
vQpd9q0zavtcIGBOtCDlXpkAt1zG+MA57/9jT1Ok0s9xs7GkeVTI7uNw64x8WBMy
3FMIRUDZ2/pPcxNYjxmxTXbHIO3TgBVFl41Pf91zN/YjBObpe3BBnFwBdreQt9Fj
vCpBAQ+Ez970B3yyOfer+h5CRGYyJa3Ia8Q5ABEBAAG0CWhlbG0tZG9jc4kBTgQT
AQgAOBYhBJpDpTNgM0VH62ap7vG7/dhd8PBfBQJfLHYOAhsDBQsJCAcCBhUKCQgL
AgQWAgMBAh4BAheAAAoJEPG7/dhd8PBfc0YH/jZhBJcrvxfvIi6jBziui5kdZlpd
VHXQ/JtG7WwXt53WJZ0a2/XGh+50wT1fYD9K5LellRCj9tsJwiFWHvM0tCoZimV6
snmTP/lfYE1D9B1xyDbxbwQJNffV3k45oC4dIaJT8NufwYMyuSzA19k5u3ye2O61
L3qEVJwApBiA79mQ6O6I8pSiFP5dvh7hrz8OHm8df/GLSMalkI3d0XOzJoj1jxW2
qZLYi670oxbmUlejg41Qmqg8K2vnxO0irHI4AGNS9SFxvl84/h02TytWkI+wWxDO
+Ata05klnYEQ0VQ6pRNzECx5d20863T9fZDpiFh8KtnmVYLeUsfPDbiNyFG5AQ0E
Xyx2DgEIANGhHyRfBgoY0ZJN3Dla+8EgQJ90as+t+TMChK1xB7TCZ5PpvZdtUbZw
mYlXxAyrJOUTez1MT5z4Qt/SFpKqgy1ehGNguFvCud/p0ExfGOgZRptje/HVah3f
NHJlLd65uDczobnYqUnYJfeay4sEANsZ3SD6w3HrNbc/kHYQE7R+9Ps2WfP1Kd7G
BcHEy4lfWiK5dqj0FKFGf8XeqNZLSC/EyJ2THkEQKKLtwAlAvFA81hFrf5PmrDN0
irPKsfS4C7bhvYUX8/AAhVL5mtYAtwY1kay7N/iS789kke0NtTYeHNhYrZx7WdVF
U32RLEV4Reva86SmZhMcK9M5QBNzJkUAEQEAAYkBNgQYAQgAIBYhBJpDpTNgM0VH
62ap7vG7/dhd8PBfBQJfLHYOAhsMAAoJEPG7/dhd8PBfHvoH/3x2dcW/V+CQOoHy
TmqEfTIKmaFByxQG2sfNvrJ2WA8OJqazhjwYnDb5aMtgyHz6j7lTS3kM5gkH5jcM
dM8Agw99xnfBbl4jSAs8NyzPByyEhFvQVrIDklXiHGiv9h0MNw0zLA6LWNKCyxz8
+hBp3TcOL+AcF36piKV/HORuZHnGwg1vcYWWjHFMVQ4OVKPSGViifXYShex82bwk
EM5tR68PFW0XxQy5DvTIXRjLFH2ai4AIWWuYv6b72p0lwZRMMl1St1iNy3Vs9H2y
fmJZkZh88k65CSvARWjFOx6juITXAKVgH9UAKHE2bypYS4CRovMTxXvfiP1Dtj3o
xC3v6C0=
=JO1k
-----END PGP PUBLIC KEY BLOCK-----
07070100000002000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002300000000helm-docs-1.11.1/.github/workflows07070100000003000081A400000000000000000000000164C03CE4000002F9000000000000000000000000000000000000002D00000000helm-docs-1.11.1/.github/workflows/build.ymlname: Build

on:
  push:
    branches:
    - "*"
    tags-ignore:
    - "*"
  pull_request:
    types: [opened, reopened]

07070100000004000081A400000000000000000000000164C03CE400000419000000000000000000000000000000000000002F00000000helm-docs-1.11.1/.github/workflows/release.ymlname: Release

on:
  push:
    tags:
    - "*"

jobs:
  goreleaser:
    runs-on: ubuntu-latest
    env:
      DOCKER_CLI_EXPERIMENTAL: "enabled"
    steps:
    - name: Set up QEMU
      uses: docker/setup-qemu-action@v2
    - name: Set up Docker Buildx
      uses: docker/setup-buildx-action@v2
    - uses: actions/checkout@v3
      with:
        fetch-depth: 0
    - uses: actions/setup-go@v4
      with:
        go-version: '^1.18.0'
    - name: Login to Docker hub
      run: docker login -u ${{ secrets.DOCKER_HUB_USER }} -p ${{ secrets.DOCKER_HUB_PASSWORD }}
    - name: Import GPG key
      id: import_gpg
      uses: crazy-max/ghaction-import-gpg@v4
      with:
        gpg_private_key: ${{ secrets.SIGNING_KEY }}
    - uses: goreleaser/goreleaser-action@v4
      with:
        args: release
      env:
        GITHUB_TOKEN: ${{ secrets.NORWOODJ_ORG_TOKEN }}
        GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}
        PROJECT_ROOT: ${{ env.GITHUB_WORKSPACE }}
    - if: always()
      run: rm -f ${HOME}/.docker/config.json
07070100000005000081A400000000000000000000000164C03CE400000046000000000000000000000000000000000000001C00000000helm-docs-1.11.1/.gitignore/helm-docs
/cmd/helm-docs/helm-docs
dist
.idea/
*.iml
.vscode/
vendor/07070100000006000081A400000000000000000000000164C03CE400000C63000000000000000000000000000000000000002100000000helm-docs-1.11.1/.goreleaser.ymlproject_name: helm-docs
env:
  - PROJECT_ROOT={{ .Env.PROJECT_ROOT }}
before:
  hooks:
    - go mod download
    - go test ./...
builds:
  - main: ./cmd/helm-docs
    env:
      - CGO_ENABLED=0
    goarch:
      - amd64
      - arm
      - arm64
    goarm:
      - 6
      - 7
    goos:
      - darwin
      - linux
      - windows
archives:
  - id: default
    name_template: >-
      {{ .ProjectName }}_
      {{- title .Os }}_
      {{- if eq .Arch "amd64" }}x86_64
      {{- else if eq .Arch "386" }}i386
      {{- else if eq .Arch "arm" }}{{ .Arch }}{{ .Arm }}
      {{- else }}{{ .Arch }}{{ end }}

checksum:
  name_template: checksums.txt
snapshot:
  name_template: "{{ .Tag }}-next"
changelog:
  sort: asc
  filters:
    exclude:
      - "^docs:"
      - "^test:"

signs:
- artifacts: checksum
  args: ["-u", "{{ .Env.GPG_FINGERPRINT }}", "--output", "${signature}", "--detach-sign", "${artifact}"]

nfpms:
- vendor: helm-docs
  homepage: https://github.com/norwoodj/helm-docs
  maintainer: norwoodj
  description: A tool for automatically generating markdown documentation for helm charts
  license: GNU General Public License v3.0
  formats:
  - deb
  - rpm
  file_name_template: >-
    {{ .ProjectName }}_
    {{- title .Os }}_
    {{- if eq .Arch "amd64" }}x86_64
    {{- else if eq .Arch "386" }}i386
    {{- else if eq .Arch "arm" }}{{ .Arch }}{{ .Arm }}
    {{- else }}{{ .Arch }}{{ end }}

brews:
  - repository:
      owner: norwoodj
      name: homebrew
    folder: Formula
    homepage: https://github.com/norwoodj/helm-docs
    description: Automatically generate markdown documentation for helm charts
    install: |
      bin.install "helm-docs"
    test: |
      system "#{bin}/helm-docs --version"
dockers:
  - goos: linux
    goarch: amd64
    dockerfile: Dockerfile
    use: buildx
    build_flag_templates:
      - --platform=linux/amd64
    image_templates:
      - jnorwood/{{ .ProjectName }}:{{ .Tag }}-amd64
  - goos: linux
    goarch: arm64
    dockerfile: Dockerfile
    use: buildx
    build_flag_templates:
      - --platform=linux/arm64
    image_templates:
      - jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64
  - goos: linux
    goarch: arm
    goarm: 6
    dockerfile: Dockerfile
    use: buildx
    build_flag_templates:
      - --platform=linux/arm/v6
    image_templates:
      - jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64v6
  - goos: linux
    goarch: arm
    goarm: 7
    dockerfile: Dockerfile
    use: buildx
    build_flag_templates:
      - --platform=linux/arm/v7
    image_templates:
      - jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64v7
docker_manifests:
- name_template: jnorwood/{{ .ProjectName }}:{{ .Tag }}
  image_templates:
    - jnorwood/{{ .ProjectName }}:{{ .Tag }}-amd64
    - jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64
    - jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64v6
    - jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64v7
- name_template: jnorwood/{{ .ProjectName }}:latest
  image_templates:
    - jnorwood/{{ .ProjectName }}:{{ .Tag }}-amd64
    - jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64
    - jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64v6
    - jnorwood/{{ .ProjectName }}:{{ .Tag }}-arm64v7
07070100000007000081A400000000000000000000000164C03CE400000042000000000000000000000000000000000000002100000000helm-docs-1.11.1/.helmdocsignoreexample-charts/ignored-zero
example-charts/ignored-one/Chart.yaml
07070100000008000081A400000000000000000000000164C03CE400000254000000000000000000000000000000000000002900000000helm-docs-1.11.1/.pre-commit-config.yamlrepos:
  - repo: https://github.com/norwoodj/helm-docs
    rev: v1.2.0
    hooks:
      - id: helm-docs
        args:
          # Make the tool search for charts only under the `example-charts` directory
          - --chart-search-root=example-charts

# The `./` makes it relative to the chart-search-root set above
          - --template-files=./_templates.gotmpl

# Repeating the flag adds this to the list, now [./_templates.gotmpl, README.md.gotmpl]
          # A base filename makes it relative to each chart directory found
          - --template-files=README.md.gotmpl
07070100000009000081A400000000000000000000000164C03CE4000002B7000000000000000000000000000000000000002800000000helm-docs-1.11.1/.pre-commit-hooks.yaml- id: helm-docs
  args: []
  description: Uses 'helm-docs' to create documentation from the Helm chart's 'values.yaml' file, and inserts the result into a corresponding 'README.md' file.
  entry: git-hook/helm-docs
  files: (README\.md\.gotmpl|(Chart|requirements|values)\.yaml)$
  language: script
  name: Helm Docs
  require_serial: true

- id: helm-docs-built
  args: []
  description: Uses auto built 'helm-docs' to create documentation from the Helm chart's 'values.yaml' file, and inserts the result into a corresponding 'README.md' file.
  entry: helm-docs
  files: (README\.md\.gotmpl|(Chart|requirements|values)\.yaml)$
  language: golang
  name: Helm Docs Built
  require_serial: true
0707010000000A000081A400000000000000000000000164C03CE40000012A000000000000000000000000000000000000002100000000helm-docs-1.11.1/CONTRIBUTING.md# Contributing to helm-docs

## Testing

### Benchmarks

If you are working on a feature that is likely to impact performance, consider running benchmarks
and comparing the results before and after your change.

To run benchmarks, run the command:

```
go test -run=^$ -bench=. ./cmd/helm-docs
```
0707010000000B000081A400000000000000000000000164C03CE400000059000000000000000000000000000000000000001C00000000helm-docs-1.11.1/DockerfileFROM alpine:3.15

COPY helm-docs /usr/bin/

WORKDIR /helm-docs

ENTRYPOINT ["helm-docs"]
0707010000000C000081A400000000000000000000000164C03CE40000894B000000000000000000000000000000000000001900000000helm-docs-1.11.1/LICENSE                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

Preamble

The GNU General Public License is a free, copyleft license for
software and other kinds of works.

The licenses for most software and other practical works are designed
to take away your freedom to share and change the works.  By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.  We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors.  You can apply it to
your programs, too.

When we speak of free software, we are referring to freedom, not
price.  Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.

To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights.  Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.

For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received.  You must make sure that they, too, receive
or can get the source code.  And you must show them these terms so they
know their rights.

Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.

For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software.  For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.

Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so.  This is fundamentally incompatible with the aim of
protecting users' freedom to change the software.  The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable.  Therefore, we
have designed this version of the GPL to prohibit the practice for those
products.  If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.

Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary.  To prevent this, the GPL assures that
patents cannot be used to render the program non-free.

The precise terms and conditions for copying, distribution and
modification follow.

TERMS AND CONDITIONS

0. Definitions.

"This License" refers to version 3 of the GNU General Public License.

"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.

"The Program" refers to any copyrightable work licensed under this
License.  Each licensee is addressed as "you".  "Licensees" and
"recipients" may be individuals or organizations.

To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy.  The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.

A "covered work" means either the unmodified Program or a work based
on the Program.

To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy.  Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.

To "convey" a work means any kind of propagation that enables other
parties to make or receive copies.  Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License.  If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.

1. Source Code.

The "source code" for a work means the preferred form of the work
for making modifications to it.  "Object code" means any non-source
form of a work.

A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.

The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form.  A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.

The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities.  However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work.  For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.

The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.

The Corresponding Source for a work in source code form is that
same work.

2. Basic Permissions.

All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met.  This License explicitly affirms your unlimited
permission to run the unmodified Program.  The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work.  This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force.  You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright.  Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under
the conditions stated below.  Sublicensing is not allowed; section 10
makes it unnecessary.

3. Protecting Users' Legal Rights From Anti-Circumvention Law.

No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.

When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.

4. Conveying Verbatim Copies.

You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.

5. Conveying Modified Source Versions.

You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:

a) The work must carry prominent notices stating that you modified
    it, and giving a relevant date.

b) The work must carry prominent notices stating that it is
    released under this License and any conditions added under section
    7.  This requirement modifies the requirement in section 4 to
    "keep intact all notices".

c) You must license the entire work, as a whole, under this
    License to anyone who comes into possession of a copy.  This
    License will therefore apply, along with any applicable section 7
    additional terms, to the whole of the work, and all its parts,
    regardless of how they are packaged.  This License gives no
    permission to license the work in any other way, but it does not
    invalidate such permission if you have separately received it.

d) If the work has interactive user interfaces, each must display
    Appropriate Legal Notices; however, if the Program has interactive
    interfaces that do not display Appropriate Legal Notices, your
    work need not make them do so.

A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit.  Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.

6. Conveying Non-Source Forms.

You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:

a) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by the
    Corresponding Source fixed on a durable physical medium
    customarily used for software interchange.

b) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by a
    written offer, valid for at least three years and valid for as
    long as you offer spare parts or customer support for that product
    model, to give anyone who possesses the object code either (1) a
    copy of the Corresponding Source for all the software in the
    product that is covered by this License, on a durable physical
    medium customarily used for software interchange, for a price no
    more than your reasonable cost of physically performing this
    conveying of source, or (2) access to copy the
    Corresponding Source from a network server at no charge.

c) Convey individual copies of the object code with a copy of the
    written offer to provide the Corresponding Source.  This
    alternative is allowed only occasionally and noncommercially, and
    only if you received the object code with such an offer, in accord
    with subsection 6b.

d) Convey the object code by offering access from a designated
    place (gratis or for a charge), and offer equivalent access to the
    Corresponding Source in the same way through the same place at no
    further charge.  You need not require recipients to copy the
    Corresponding Source along with the object code.  If the place to
    copy the object code is a network server, the Corresponding Source
    may be on a different server (operated by you or a third party)
    that supports equivalent copying facilities, provided you maintain
    clear directions next to the object code saying where to find the
    Corresponding Source.  Regardless of what server hosts the
    Corresponding Source, you remain obligated to ensure that it is
    available for as long as needed to satisfy these requirements.

e) Convey the object code using peer-to-peer transmission, provided
    you inform other peers where the object code and Corresponding
    Source of the work are being offered to the general public at no
    charge under subsection 6d.

A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.

A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling.  In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage.  For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product.  A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.

"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source.  The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.

If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information.  But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).

The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed.  Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.

Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.

7. Additional Terms.

"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law.  If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it.  (Additional permissions may be written to require their own
removal in certain cases when you modify the work.)  You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:

a) Disclaiming warranty or limiting liability differently from the
    terms of sections 15 and 16 of this License; or

b) Requiring preservation of specified reasonable legal notices or
    author attributions in that material or in the Appropriate Legal
    Notices displayed by works containing it; or

c) Prohibiting misrepresentation of the origin of that material, or
    requiring that modified versions of such material be marked in
    reasonable ways as different from the original version; or

d) Limiting the use for publicity purposes of names of licensors or
    authors of the material; or

e) Declining to grant rights under trademark law for use of some
    trade names, trademarks, or service marks; or

f) Requiring indemnification of licensors and authors of that
    material by anyone who conveys the material (or modified versions of
    it) with contractual assumptions of liability to the recipient, for
    any liability that these contractual assumptions directly impose on
    those licensors and authors.

All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10.  If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term.  If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.

Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.

8. Termination.

You may not propagate or modify a covered work except as expressly
provided under this License.  Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).

However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.

Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License.  If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.

9. Acceptance Not Required for Having Copies.

You are not required to accept this License in order to receive or
run a copy of the Program.  Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance.  However,
nothing other than this License grants you permission to propagate or
modify any covered work.  These actions infringe copyright if you do
not accept this License.  Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.

10. Automatic Licensing of Downstream Recipients.

Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License.  You are not responsible
for enforcing compliance by third parties with this License.

An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations.  If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License.  For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.

11. Patents.

A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based.  The
work thus licensed is called the contributor's "contributor version".

A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version.  For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.

In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement).  To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.

If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients.  "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.

A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License.  You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.

12. No Surrender of Others' Freedom.

If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License.  If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all.  For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.

13. Use with the GNU Affero General Public License.

Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work.  The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.

14. Revised Versions of this License.

The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time.  Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

Each version is given a distinguishing version number.  If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation.  If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.

If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.

Later license versions may give you additional or different
permissions.  However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.

15. Disclaimer of Warranty.

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

16. Limitation of Liability.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

17. Interpretation of Sections 15 and 16.

If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program.  It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>

This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:

<program>  Copyright (C) <year>  <name of author>
    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License.  Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".

You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.

The GNU General Public License does not permit incorporating your program
into proprietary programs.  If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library.  If this is what you want to do, use the GNU Lesser General
Public License instead of this License.  But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
0707010000000D000081A400000000000000000000000164C03CE400000139000000000000000000000000000000000000001A00000000helm-docs-1.11.1/Makefilehelm-docs:
	go build github.com/norwoodj/helm-docs/cmd/helm-docs

install:
	go install github.com/norwoodj/helm-docs/cmd/helm-docs

.PHONY: fmt
fmt:
	go fmt ./...

.PHONY: test
test:
	go test -v ./...

.PHONY: clean
clean:
	rm -f helm-docs

.PHONY: dist
dist:
	goreleaser release --rm-dist --snapshot --skip-sign
0707010000000E000081A400000000000000000000000164C03CE40000614F000000000000000000000000000000000000001B00000000helm-docs-1.11.1/README.mdhelm-docs
=========
[![Go Report Card](https://goreportcard.com/badge/github.com/norwoodj/helm-docs)](https://goreportcard.com/report/github.com/norwoodj/helm-docs)

The helm-docs tool 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.

The markdown generation is entirely [gotemplate](https://golang.org/pkg/text/template) driven. The tool parses metadata
from charts and generates a number of sub-templates that can be referenced in a template file (by default `README.md.gotmpl`).
If no template file is provided, the tool has a default internal template that will generate a reasonably formatted README.

The most useful aspect of this tool is the auto-detection of field descriptions from comments:
```yaml
config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgres

# -- database for the [hashbash](https://github.com/norwoodj/hashbash-backend-go) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}

statefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresql
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}
```

Resulting in a resulting README section like so:

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| config.databasesToCreate[0] | string | `"postgresql"` | default database for storage of database metadata |
| config.databasesToCreate[1] | string | `"hashbash"` | database for the [hashbash](https://github.com/norwoodj/hashbash-backend-go) project |
| config.usersToCreate[0] | object | `{"admin":true,"name":"root"}` | admin user |
| config.usersToCreate[1] | object | `{"name":"hashbash","readwriteDatabases":["hashbash"]}` | user with access to the database with the same name |
| statefulset.extraVolumes | list | `[{"emptyDir":{},"name":"data"}]` | Additional volumes to be mounted into the database container |
| statefulset.image.repository | string | `"jnorwood/postgresql:11"` | Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files |
| statefulset.image.tag | string | `"18.0831"` |  |

You'll notice that some complex fields (lists and objects) are documented while others aren't, and that some simple fields
like `statefulset.image.tag` are documented even without a description comment. The rules for what is and isn't documented in
the final table will be described in detail later in this document.

## Installation
helm-docs can be installed using [homebrew](https://brew.sh/):

```bash
brew install norwoodj/tap/helm-docs
```

or [scoop](https://scoop.sh):

```bash
scoop install helm-docs
```

This will download and install the [latest release](https://github.com/norwoodj/helm-docs/releases/latest)
of the tool.

To build from source in this repository:

```bash
cd cmd/helm-docs
go build
```

Or install from source:

```bash
GO111MODULE=on go get github.com/norwoodj/helm-docs/cmd/helm-docs
```

## Usage

### Pre-commit hook

If you want to automatically generate `README.md` files with a pre-commit hook, make sure you
[install the pre-commit binary](https://pre-commit.com/#install), and add a [.pre-commit-config.yaml file](./.pre-commit-config.yaml)
to your project. Then run:

```bash
pre-commit install
pre-commit install-hooks
```

Future changes to your chart's `requirements.yaml`, `values.yaml`, `Chart.yaml`, or `README.md.gotmpl` files will cause an update to documentation when you commit.

### Running the binary directly

To run and generate documentation into READMEs for all helm charts within or recursively contained by a directory:

```bash
helm-docs
# OR
helm-docs --dry-run # prints generated documentation to stdout rather than modifying READMEs
```

The tool searches recursively through subdirectories of the current directory for `Chart.yaml` files and generates documentation
for every chart that it finds.

### Using docker

You can mount a directory with charts under `/helm-docs` within the container.

Then run:

```bash
docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
```

## Ignoring Chart Directories
helm-docs supports a `.helmdocsignore` file, exactly like a `.gitignore` file in which one can specify directories to ignore
when searching for charts. Directories specified need not be charts themselves, so parent directories containing potentially
many charts can be ignored and none of the charts underneath them will be processed. You may also directly reference the
Chart.yaml file for a chart to skip processing for it.

## Generating Doc with Dependency values
Umbrella Helm chart documentation can include dependency values with `document-dependency-values` flag.
All dependency values will be merged into values of umbrella chart documentation.

If you want to include dependency values, but don't want to generate doc for each dependency:
* set `chart-search-root` parameter to directory that contains umbrella chart and all dependency charts.
* list all charts you want to generate doc using `chart-to-generate` flag
* set `document-dependency-values` flag to true

## Markdown Rendering
There are two important parameters to be aware of when running helm-docs. `--chart-search-root` specifies the directory
under which the tool will recursively search for charts to render documentation for. `--template-files` specifies the list
of gotemplate files that should be used in rendering the resulting markdown file for each chart found. By default
`--chart-search-root=.` and `--template-files=README.md.gotmpl`.

If a template file is specified as a filename only as with the default above, the file is interpreted as being _relative to each chart directory found_.
If however a template file is specified as a relative path, e.g. the first of `--template-files=./_templates.gotmpl --template-files=README.md.gotmpl`
then the file is interpreted as being relative to the `chart-search-root`.

This repo is a good example of this in action. If you take a look at the [.pre-commit-config.yaml file](./.pre-commit-config.yaml)
here, you'll see our search root is set to [example-charts](./example-charts) and the list of templates used for each chart
is the [_templates.gotmpl file in that directory](./example-charts/_templates.gotmpl) and the README.md.gotmpl file in
each chart directory.

If any of the specified template files is not found for a chart (you'll notice most of the example charts do not have a README.md.gotmpl)
file, then the internal default template is used instead.

In addition to extra defined templates you specify in these template files, there are quite a few built-in templates that
can be used as well:

| Name | Description |
|------|-------------|
| chart.header              | The main heading of the generated markdown file |
| chart.name                | The _name_ field from the chart's `Chart.yaml` file |
| chart.deprecationWarning  | A deprecation warning which is displayed when the _deprecated_ field from the chart's `Chart.yaml` file is `true` |
| chart.description         | A description line containing the _description_ field from the chart's `Chart.yaml` file, or "" if that field is not set |
| chart.version             | The _version_ field from the chart's `Chart.yaml` file |
| chart.versionBadge        | A badge stating the current version of the chart |
| chart.type                | The _type_ field from the chart's `Chart.yaml` file |
| chart.typeBadge           | A badge stating the current type of the chart |
| chart.appVersion          | The _appVersion_ field from the chart's `Chart.yaml` file |
| chart.appVersionBadge     | A badge stating the current appVersion of the chart |
| chart.homepage            | The _home_ link from the chart's `Chart.yaml` file, or "" if that field is not set |
| chart.homepageLine        | A text line stating the current homepage of the chart |
| chart.maintainersHeader   | The heading for the chart maintainers section |
| chart.maintainersTable    | A table of the chart's maintainers |
| chart.maintainersSection  | A section headed by the maintainersHeader from above containing the maintainersTable from above or "" if there are no maintainers |
| chart.sourcesHeader       | The heading for the chart sources section |
| chart.sourcesList         | A list of the chart's sources |
| chart.sourcesSection      | A section headed by the sourcesHeader from above containing the sourcesList from above or "" if there are no sources |
| chart.kubeVersion         | The _kubeVersion_ field from the chart's `Chart.yaml` file |
| chart.kubeVersionLine     | A text line stating the required Kubernetes version for the chart |~~~~
| chart.requirementsHeader  | The heading for the chart requirements section |
| chart.requirementsTable   | A table of the chart's required sub-charts |
| chart.requirementsSection | A section headed by the requirementsHeader from above containing the kubeVersionLine and/or the requirementsTable from above or "" if there are no requirements |
| chart.valuesHeader        | The heading for the chart values section |
| chart.valuesTable         | A table of the chart's values parsed from the `values.yaml` file (see below) |
| chart.valuesSection       | A section headed by the valuesHeader from above containing the valuesTable from above or "" if there are no values |
| chart.valuesTableHtml     | Like `chart.valuesTable` but it is rendered as (X)HTML tags to allow further rendering customization, instead of markdown tables format. |
| chart.valuesSectionHtml   | Like `chart.valuesSection` but uses `chart.valuesTableHtml` |
| chart.valueDefaultColumnRender | This is a hook template if you want to redefine how helm-docs render the default values in `chart.valuesTableHtml` mode. This is especially useful when combined with (X)HTML tags, so that you can nicely format multiline default values, like YAML/JSON object tree snippet with codeblock syntax highlighter, which is not possible or difficult when using the markdown table format. It can be redefined in your template file. |

The default internal template mentioned above uses many of these and looks like this:
```
{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}

{{ template "chart.valuesSection" . }}
```

The tool also includes the [sprig templating library](https://github.com/Masterminds/sprig), so those functions can be used
in the templates you supply.

### values.yaml metadata
This tool can parse descriptions and defaults of values from `values.yaml` files. The defaults are pulled directly from
the yaml in the file.

It was formerly the case that descriptions had to be specified with the full path of the yaml field. This is no longer
the case, although it is still supported. Where before you would document a values.yaml like so:

```yaml
controller:
  publishService:
    # controller.publishService.enabled -- Whether to expose the ingress controller to the public world
    enabled: false

# controller.replicas -- Number of nginx-ingress pods to load balance between.
  # Do not set this below 2.
  replicas: 2
```

You may now equivalently write:
```yaml
controller:
  publishService:
    # -- Whether to expose the ingress controller to the public world
    enabled: false

# -- Number of nginx-ingress pods to load balance between.
  # Do not set this below 2.
  replicas: 2
```

New-style comments are much the same as the old-style comments, except that while old comments for a field could appear
anywhere in the file, new-style comments must appear **on the line(s) immediately preceding the field being documented.**

I invite you to check out the [example-charts](./example-charts) to see how this is done in practice. The `but-auto-comments`
examples in particular document the new comment format.

Note that comments can continue on the next line. In that case leave out the double dash, and the lines will simply be
appended with a space in-between, as in the `controller.replicas` field in the example above

The following rules are used to determine which values will be added to the values table in the README:

* By default, only _leaf nodes_, that is, fields of type `int`, `string`, `float`, `bool`, empty lists, and empty maps
  are added as rows in the values table. These fields will be added even if they do not have a description comment
* Lists and maps which contain elements will not be added as rows in the values table _unless_ they have a description
  comment which refers to them
* Adding a description comment for a non-empty list or map in this way makes it so that leaf nodes underneath the
  described field will _not_ be automatically added to the values table. In order to document both a non-empty list/map
  _and_ a leaf node within that field, description comments must be added for both

e.g. In this case, both `controller.livenessProbe` and `controller.livenessProbe.httpGet.path` will be added as rows in
the values table, but `controller.livenessProbe.httpGet.port` will not
```yaml
controller:
  # -- Configure the healthcheck for the ingress controller
  livenessProbe:
    httpGet:
      # -- This is the liveness check endpoint
      path: /healthz
      port: http
```

Results in:

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.livenessProbe | object | `{"httpGet":{"path":"/healthz","port":8080}}` | Configure the healthcheck for the ingress controller |
| controller.livenessProbe.httpGet.path | string | `"/healthz"` | This is the liveness check endpoint |

If we remove the comment for `controller.livenessProbe` however, both leaf nodes `controller.livenessProbe.httpGet.path`
and `controller.livenessProbe.httpGet.port` will be added to the table, with or without description comments:

```yaml
controller:
  livenessProbe:
    httpGet:
      # -- This is the liveness check endpoint
      path: /healthz
      port: http
```

Results in:

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.livenessProbe.httpGet.path | string | `"/healthz"` | This is the liveness check endpoint |
| controller.livenessProbe.httpGet.port | string | `"http"` | |

### nil values
If you would like to define a key for a value, but leave the default empty, you can still specify a description for it
as well as a type. This is possible with both the old and the new comment format:
```yaml
controller:
  # -- (int) Number of nginx-ingress pods to load balance between
  replicas:

# controller.image -- (string) Number of nginx-ingress pods to load balance between
  image:
```
This could be useful when wanting to enforce user-defined values for the chart, where there are no sensible defaults.

### Default values/column
In cases where you do not want to include the default value from `values.yaml`, or where the real default is calculated
inside the chart, you can change the contents of the column like so:

```yaml
service:
  # -- Add annotations to the service, this is going to be a long comment across multiple lines
  # but that's fine, these will be concatenated and the @default will be rendered as the default for this field
  # @default -- the chart will add some internal annotations automatically
  annotations: []
```

The order is important. The first comment line(s) must be the one specifying the key or using the auto-detection feature and
the description for the field. The `@default` comment must follow.

See [here](./example-charts/custom-template/values.yaml) for an example.
### Ignoring values
In cases you would like to ignore certain values, you can mark it with @ignored tag:

```yaml
# @ignored
service:
  port: 8080
```

### Spaces and Dots in keys
In the old-style comment, if a key name contains any "." or " " characters, that section of the path must be quoted in
description comments e.g.

```yaml
service:
  annotations:
    # service.annotations."external-dns.alpha.kubernetes.io/hostname" -- Hostname to be assigned to the ELB for the service
    external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com

configMap:
  # configMap."not real config param" -- A completely fake config parameter for a useful example
  not real config param: value
```

### Advanced table rendering
Some helm chart `values.yaml` uses complicated structure for the key/value
pairs. For example, it may uses a multiline string of Go template text instead
of plain strings. Some values might also refer to a certain YAML/JSON object
structure, like internal k8s value type, or an enum. For these use case,
a standard markdown table format might be inadequate and you want to use HTML
tags to render the table.

Some example use case on why you need advanced table rendering:

- Hyperlinking the value type to an anchor or HTML link somewhere for reference
 - Collapsible value description using `<summary>` tags to save space
 - Multiline default values as codeblocks, instead of one line JSON structure for readability
 - Custom rendering, for colors, actions, bookmarking, cross-reference, etc
 - Cascading the markdown file generated by helm-docs to be post-processed by Jamstack into a static HTML docs site.

In order to accomodate this, `helm-docs` provides an extensible and flexible way to customize rendering.

1. Use the HTML value renderer instead of the default markdown format

You can use `chart.valuesSectionHtml` to render the values table as HTML tags,
instead of using `chart.valuesSection`. Using HTML tables provides more
flexibility because it can be processed by markdown viewer as a nested blocks,
instead of one row per line. This allows you to customize how each columns in a
row are rendered.

2. Overriding built-in templates

You can always overrides or redefine built-in templates in your own `_templates.
gotmpl` file. The built-in templates can be thought of as a template hook.
For example, if you need to change the HTML table, for example to add a new
column, or define maximum width/height, you can override `chart.valuesTableHtml`. Your overrides will then be called by `chart.valuesSectionHtml`.

You can add your own rendering logic for each column. For example, we have `chart.valueDefaultColumnRender` that is used to render "default value" column for each rows. If you want to override how helm-docs render the
"type" column, just define your own rendering template and call it from
`chart.valuesTableHtml` for each of the rows.

3. Using the metadata of each rows of values

Custom styling and rendering can be done as flexible as you want, but you
still need a metadata that describes each rows of values. You can access
this information from the templates.

When you override `chart.valuesTableHtml`, as you can see in the original
definition in `func getValuesTableTemplates()` [pkg/document/template.go](pkg/document/template.go), we iterates each row of values.
For each "Value", it is modeled as a struct defined in `valueRow` struct
in [pkg/document/model.go](pkg/document/model.go). You can then use the
fields in your template.

Some fields here are directly referenced from `values.yaml`:
- `Key`: the full name of the key referenced in `values.yaml`
- `Type`: the type of the value of the key in `values.yaml`. Can be automatically inferred from YAML structure, or annotated using `# -- (mytype)` where `mytype` can be any string that you refer as the type of the value.
- `NotationType`: the notation of the type used to render the default value. If `Type` refers to the data type of the value, then `NotationType` refers to **how** this value should be written/rendered by helm-docs. Generally helm-docs only remembers the notation type, but it was the writer's responsibility to make a template tag to render a specific notation type. Annotate the key with `# @notationType -- (mynotation)` where `mynotation` is an identifier to tell the renderer how to write the value.
- `Default`: this is the default value of the key, found from `values.yaml`. It is either inferred from the YAML structure or defined using `# @default -- my default value` annotation, in case you need to show other example values.
- `Description`: this is the description of the key/value, taken from the comments found in the `values.yaml` for the referred key.
- `LineNumber`: this is the line number associated with where the key is declared. You can use this to construct an anchor to the actual `values.yaml` file.

Note that helm-docs only provides these information, but the default behaviour is to always render it in plain Markdown file to be viewed locally.

4. Use markdown files generated by helm-docs as intermediary files to be processed further

Public helm charts sometimes needs to be published as static content
instead of just stored in a repository. This is needed for helm users to
be able to view or browse the chart options and dependencies.

It is often more than enough to just browse the chart values options on
git hosting that is able to render markdown files as a nice HTML page, like GitHub or GitLab.
However, for a certain use case, you may want to use your own
documentation generator to host or publish the output of helm-docs.

If you use some kind of Jamstack like Gatsby or Hugo, you can use the
output of helm-docs as an input for these doc generator. A typical use
case is to override helm-docs built-in template so that it renders a
markdown or markdownX files to be processed by Gatsby or Hugo into
a static Web/Javascript page.

For a more concrete examples on how to do these custom rendering, see [example here](./example-charts/custom-value-notation-type/README.md)

## Strict linting

Sometimes you might want to enforce helm-docs to fail when some values are not documented correctly.

By default, this option is turned off:

```shell
./helm-docs -c  example-charts/helm-3
INFO[2023-06-29T07:54:29-07:00] Found Chart directories [.]                  
INFO[2023-06-29T07:54:29-07:00] Generating README Documentation for chart example-charts/helm-3 
```

but you can use the `-x` flag to turn it on:

```shell
helm-docs -x -c  example-charts/helm-3
INFO[2023-06-29T07:55:12-07:00] Found Chart directories [.]                  
WARN[2023-06-29T07:55:12-07:00] Error parsing information for chart ., skipping: values without documentation: 
controller
controller.name
controller.image
controller.extraVolumes.[0].name
controller.extraVolumes.[0].configMap
controller.extraVolumes.[0].configMap.name
controller.livenessProbe.httpGet
controller.livenessProbe.httpGet.port
controller.publishService
controller.service
controller.service.annotations
controller.service.annotations.external-dns.alpha.kubernetes.io/hostname
```

The CLI also supports excluding fields by regexp using the `-z` argument

```shell
helm-docs -x -z="controller.*" -c  example-charts/helm-3
INFO[2023-06-29T08:18:55-07:00] Found Chart directories [.]                  
INFO[2023-06-29T08:18:55-07:00] Generating README Documentation for chart example-charts/helm-3 
```

Multiple regexp can be passed, as in the following example:

```shell
helm-docs -x -z="controller.image.*" -z="controller.service.*"  -z="controller.extraVolumes.*"  -c  example-charts/helm-3
INFO[2023-06-29T08:21:04-07:00] Found Chart directories [.]                  
WARN[2023-06-29T08:21:04-07:00] Error parsing information for chart ., skipping: values without documentation: 
controller
controller.name
controller.livenessProbe.httpGet
controller.livenessProbe.httpGet.port
controller.publishService 
```

It is also possible to ignore specific errors using the `-y` argument.

```shell
helm-docs -x -y="controller.name" -y="controller.service"  -c  example-charts/helm-3
INFO[2023-06-29T08:23:40-07:00] Found Chart directories [.]                  
WARN[2023-06-29T08:23:40-07:00] Error parsing information for chart ., skipping: values without documentation: 
controller
controller.image
controller.extraVolumes.[0].name
controller.extraVolumes.[0].configMap
controller.extraVolumes.[0].configMap.name
controller.livenessProbe.httpGet
controller.livenessProbe.httpGet.port
controller.publishService
controller.service.annotations
controller.service.annotations.external-dns.alpha.kubernetes.io/hostname 
```
0707010000000F000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000001500000000helm-docs-1.11.1/cmd07070100000010000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000001F00000000helm-docs-1.11.1/cmd/helm-docs07070100000011000081A400000000000000000000000164C03CE400000E63000000000000000000000000000000000000002F00000000helm-docs-1.11.1/cmd/helm-docs/command_line.gopackage main

import (
	"fmt"
	"os"
	"strings"

"github.com/norwoodj/helm-docs/pkg/document"
	log "github.com/sirupsen/logrus"
	"github.com/spf13/cobra"
	"github.com/spf13/viper"
)

var version string

func possibleLogLevels() []string {
	levels := make([]string, 0)

for _, l := range log.AllLevels {
		levels = append(levels, l.String())
	}

return levels
}

func initializeCli() {
	logLevelName := viper.GetString("log-level")
	logLevel, err := log.ParseLevel(logLevelName)
	if err != nil {
		log.Errorf("Failed to parse provided log level %s: %s", logLevelName, err)
		os.Exit(1)
	}

log.SetFormatter(&log.TextFormatter{FullTimestamp: true})
	log.SetLevel(logLevel)
}

func newHelmDocsCommand(run func(cmd *cobra.Command, args []string)) (*cobra.Command, error) {
	command := &cobra.Command{
		Use:     "helm-docs",
		Short:   "helm-docs automatically generates markdown documentation for helm charts from requirements and values files",
		Version: version,
		Run:     run,
	}

logLevelUsage := fmt.Sprintf("Level of logs that should printed, one of (%s)", strings.Join(possibleLogLevels(), ", "))
	command.PersistentFlags().StringP("chart-search-root", "c", ".", "directory to search recursively within for charts")
	command.PersistentFlags().BoolP("dry-run", "d", false, "don't actually render any markdown files just print to stdout passed")
	command.PersistentFlags().Bool("ignore-non-descriptions", false, "ignore values without a comment, this values will not be included in the README")
	command.PersistentFlags().StringP("ignore-file", "i", ".helmdocsignore", "The filename to use as an ignore file to exclude chart directories")
	command.PersistentFlags().StringP("log-level", "l", "info", logLevelUsage)
	command.PersistentFlags().StringP("output-file", "o", "README.md", "markdown file path relative to each chart directory to which rendered documentation will be written")
	command.PersistentFlags().StringP("sort-values-order", "s", document.AlphaNumSortOrder, fmt.Sprintf("order in which to sort the values table (\"%s\" or \"%s\")", document.AlphaNumSortOrder, document.FileSortOrder))
	command.PersistentFlags().StringSliceP("template-files", "t", []string{"README.md.gotmpl"}, "gotemplate file paths relative to each chart directory from which documentation will be generated")
	command.PersistentFlags().StringP("badge-style", "b", "flat-square", "badge style to use for charts")
	command.PersistentFlags().StringP("values-file", "f", "values.yaml", "Path to values file")
	command.PersistentFlags().BoolP("document-dependency-values", "u", false, "For charts with dependencies, include the dependency values in the chart values documentation")
	command.PersistentFlags().StringSliceP("chart-to-generate", "g", []string{}, "List of charts that will have documentation generated. Comma separated, no space. Empty list - generate for all charts in chart-search-root")
	command.PersistentFlags().BoolP("documentation-strict-mode", "x", false, "Fail the generation of docs if there are undocumented values")
	command.PersistentFlags().StringSliceP("documentation-strict-ignore-absent", "y", []string{"service.type", "image.repository", "image.tag"}, "A comma separate values which are allowed not to be documented in strict mode")
	command.PersistentFlags().StringSliceP("documentation-strict-ignore-absent-regex", "z", []string{".*service\\.type", ".*image\\.repository", ".*image\\.tag"}, "A comma separate values which are allowed not to be documented in strict mode")

viper.AutomaticEnv()
	viper.SetEnvPrefix("HELM_DOCS")
	viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
	err := viper.BindPFlags(command.PersistentFlags())

return command, err
}
07070100000012000081A400000000000000000000000164C03CE40000193C000000000000000000000000000000000000002700000000helm-docs-1.11.1/cmd/helm-docs/main.gopackage main

import (
	"fmt"
	"os"
	"path"
	"path/filepath"
	"reflect"
	"regexp"
	"runtime"
	"strings"
	"sync"

log "github.com/sirupsen/logrus"
	"github.com/spf13/cobra"
	"github.com/spf13/viper"

"github.com/norwoodj/helm-docs/pkg/document"
	"github.com/norwoodj/helm-docs/pkg/helm"
)

// parallelProcessIterable runs the visitFn function on each element of the iterable, using
// parallelism number of worker goroutines. The iterable may be a slice or a map. In the case of a
// map, the argument passed to visitFn will be the key.
func parallelProcessIterable(iterable interface{}, parallelism int, visitFn func(elem interface{})) {
	workChan := make(chan interface{})

wg := &sync.WaitGroup{}
	wg.Add(parallelism)

for i := 0; i < parallelism; i++ {
		go func() {
			defer wg.Done()
			for elem := range workChan {
				visitFn(elem)
			}
		}()
	}

iterableValue := reflect.ValueOf(iterable)

if iterableValue.Kind() == reflect.Map {
		for _, key := range iterableValue.MapKeys() {
			workChan <- key.Interface()
		}
	} else {
		sliceLen := iterableValue.Len()
		for i := 0; i < sliceLen; i++ {
			workChan <- iterableValue.Index(i).Interface()
		}
	}

close(workChan)
	wg.Wait()
}

func getDocumentationParsingConfigFromArgs() (helm.ChartValuesDocumentationParsingConfig, error) {
	var regexps []*regexp.Regexp
	regexpStrings := viper.GetStringSlice("documentation-strict-ignore-absent-regex")
	for _, item := range regexpStrings {
		regex, err := regexp.Compile(item)
		if err != nil {
			return helm.ChartValuesDocumentationParsingConfig{}, err
		}
		regexps = append(regexps, regex)
	}
	return helm.ChartValuesDocumentationParsingConfig{
		StrictMode:                 viper.GetBool("documentation-strict-mode"),
		AllowedMissingValuePaths:   viper.GetStringSlice("documentation-strict-ignore-absent"),
		AllowedMissingValueRegexps: regexps,
	}, nil
}

func readDocumentationInfoByChartPath(chartSearchRoot string, parallelism int) (map[string]helm.ChartDocumentationInfo, error) {
	var fullChartSearchRoot string

if path.IsAbs(chartSearchRoot) {
		fullChartSearchRoot = chartSearchRoot
	} else {
		cwd, err := os.Getwd()
		if err != nil {
			return nil, fmt.Errorf("error getting working directory: %w", err)
		}

fullChartSearchRoot = filepath.Join(cwd, chartSearchRoot)
	}

chartDirs, err := helm.FindChartDirectories(fullChartSearchRoot)
	if err != nil {
		return nil, fmt.Errorf("error finding chart directories: %w", err)
	}

log.Infof("Found Chart directories [%s]", strings.Join(chartDirs, ", "))

templateFiles := viper.GetStringSlice("template-files")
	log.Debugf("Rendering from optional template files [%s]", strings.Join(templateFiles, ", "))

documentationInfoByChartPath := make(map[string]helm.ChartDocumentationInfo, len(chartDirs))
	documentationInfoByChartPathMu := &sync.Mutex{}
	documentationParsingConfig, err := getDocumentationParsingConfigFromArgs()
	if err != nil {
		return nil, fmt.Errorf("error parsing the linting config%w", err)
	}

parallelProcessIterable(chartDirs, parallelism, func(elem interface{}) {
		chartDir := elem.(string)
		info, err := helm.ParseChartInformation(filepath.Join(chartSearchRoot, chartDir), documentationParsingConfig)
		if err != nil {
			log.Warnf("Error parsing information for chart %s, skipping: %s", chartDir, err)
			return
		}
		documentationInfoByChartPathMu.Lock()
		documentationInfoByChartPath[info.ChartDirectory] = info
		documentationInfoByChartPathMu.Unlock()
	})

return documentationInfoByChartPath, nil
}

func getChartToGenerate(documentationInfoByChartPath map[string]helm.ChartDocumentationInfo) map[string]helm.ChartDocumentationInfo {
	generateDirectories := viper.GetStringSlice("chart-to-generate")
	if len(generateDirectories) == 0 {
		return documentationInfoByChartPath
	}
	documentationInfoToGenerate := make(map[string]helm.ChartDocumentationInfo, len(generateDirectories))
	var skipped = false
	for _, chartDirectory := range generateDirectories {
		if info, ok := documentationInfoByChartPath[chartDirectory]; ok {
			documentationInfoToGenerate[chartDirectory] = info
		} else {
			log.Warnf("Couldn't find documentation Info for <%s> - skipping", chartDirectory)
			skipped = true
		}
	}
	if skipped {
		possibleCharts := []string{}
		for path := range documentationInfoByChartPath {
			possibleCharts = append(possibleCharts, path)
		}
		log.Warnf("Some charts listed in `chart-to-generate` wasn't found. List of charts to choose: [%s]", strings.Join(possibleCharts, ", "))
	}
	return documentationInfoToGenerate
}

func writeDocumentation(chartSearchRoot string, documentationInfoByChartPath map[string]helm.ChartDocumentationInfo, dryRun bool, parallelism int) {
	templateFiles := viper.GetStringSlice("template-files")
	badgeStyle := viper.GetString("badge-style")

log.Debugf("Rendering from optional template files [%s]", strings.Join(templateFiles, ", "))

documentDependencyValues := viper.GetBool("document-dependency-values")
	documentationInfoToGenerate := getChartToGenerate(documentationInfoByChartPath)

parallelProcessIterable(documentationInfoToGenerate, parallelism, func(elem interface{}) {
		info := documentationInfoByChartPath[elem.(string)]
		var err error
		var dependencyValues []document.DependencyValues
		if documentDependencyValues {
			dependencyValues, err = document.GetDependencyValues(info, documentationInfoByChartPath)
			if err != nil {
				log.Warnf("Error evaluating dependency values for chart %s, skipping: %v", info.ChartDirectory, err)
				return
			}
		}
		document.PrintDocumentation(info, chartSearchRoot, templateFiles, dryRun, version, badgeStyle, dependencyValues)
	})
}

func helmDocs(_ *cobra.Command, _ []string) {
	initializeCli()

chartSearchRoot := viper.GetString("chart-search-root")
	dryRun := viper.GetBool("dry-run")

parallelism := runtime.NumCPU() * 2

// On dry runs all output goes to stdout, and so as to not jumble things, generate serially.
	if dryRun {
		parallelism = 1
	}

documentationInfoByChartPath, err := readDocumentationInfoByChartPath(chartSearchRoot, parallelism)
	if err != nil {
		log.Fatal(err)
	}

writeDocumentation(chartSearchRoot, documentationInfoByChartPath, dryRun, parallelism)
}

func main() {
	command, err := newHelmDocsCommand(helmDocs)
	if err != nil {
		log.Errorf("Failed to create the CLI commander: %s", err)
		os.Exit(1)
	}

if err := command.Execute(); err != nil {
		log.Errorf("Failed to start the CLI: %s", err)
		os.Exit(1)
	}
}
07070100000013000081A400000000000000000000000164C03CE400000D46000000000000000000000000000000000000002C00000000helm-docs-1.11.1/cmd/helm-docs/main_test.gopackage main

import (
	"fmt"
	"io"
	"io/fs"
	"os"
	"path/filepath"
	"testing"

"github.com/spf13/viper"

"github.com/norwoodj/helm-docs/pkg/document"
)

// BenchmarkHelmDocs benchmarks the entire helm-docs command by running on testdata.
//
// To run benchmarks, run the command:
//
//   go test -run=^$ -bench=. ./cmd/helm-docs
//
func BenchmarkHelmDocs(b *testing.B) {
	// Copy testdata to a new temporary directory, to keep the working directory clean.
	tmp := copyToTempDir(b, os.DirFS(filepath.Join("testdata", "benchmark")))

// Bind commandline flags.
	// NOTE: Flags must be specified even if they use the default value.
	if err := viper.BindFlagValues(testFlagSet{
		"chart-search-root":          tmp,
		"log-level":                  "warn",
		"ignore-file":                ".helmdocsignore",
		"output-file":                "README.md",
		"sort-values-order":          document.AlphaNumSortOrder,
		"document-dependency-values": true,
	}); err != nil {
		b.Fatal(err)
	}

// Benchmark the main function.
	for n := 0; n < b.N; n++ {
		helmDocs(nil, nil)
	}
}

var _ viper.FlagValueSet = &testFlagSet{}

type testFlagSet map[string]interface{}

func (s testFlagSet) VisitAll(fn func(viper.FlagValue)) {
	for k, v := range s {
		flagVal := &testFlagValue{
			name:  k,
			value: fmt.Sprintf("%v", v),
		}
		switch v.(type) {
		case bool:
			flagVal.typ = "bool"
		default:
			flagVal.typ = "string"
		}
		fn(flagVal)
	}
}

var _ viper.FlagValue = &testFlagValue{}

type testFlagValue struct {
	name  string
	value string
	typ   string
}

func (v *testFlagValue) HasChanged() bool {
	return false
}

func (v *testFlagValue) Name() string {
	return v.name
}

func (v *testFlagValue) ValueString() string {
	return v.value
}

func (v *testFlagValue) ValueType() string {
	return v.typ
}

// copyToTempDir copies the specified readonly filesystem into a new temporary directory and returns
// the path to the temporary directory. It fails the benchmark on any error and handles cleanup when
// the benchmark finishes.
func copyToTempDir(b *testing.B, fsys fs.FS) string {
	// Create the temporary directory.
	tmp, err := os.MkdirTemp("", "")
	if err != nil {
		b.Fatal(err)
	}

// Register a cleanup function on the benchmark to clean up the temporary directory.
	b.Cleanup(func() {
		if err := os.RemoveAll(tmp); err != nil {
			b.Fatal(err)
		}
	})

// Copy the filesystem to the temporary directory.
	if err := fs.WalkDir(fsys, ".", func(path string, d fs.DirEntry, _ error) error {
		// Get the path info (contains permissions, etc.)
		info, err := d.Info()
		if err != nil {
			return err
		}

// Calculate the target path in the temporary directory.
		targetPath := filepath.Join(tmp, path)

// If the path is a directory, create it.
		if d.IsDir() {
			if err := os.MkdirAll(targetPath, info.Mode()); err != nil {
				return err
			}
			return nil
		}

// If the path is a file, open it for reading.
		readFile, err := fsys.Open(path)
		if err != nil {
			return err
		}
		defer readFile.Close()

// Open a new file in the temporary directory for writing.
		writeFile, err := os.OpenFile(targetPath, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, info.Mode())
		if err != nil {
			return err
		}
		defer writeFile.Close()

// Copy the file.
		if _, err := io.Copy(writeFile, readFile); err != nil {
			return err
		}

return nil
	}); err != nil {
		b.Fatal(err)
	}

return tmp
}
07070100000014000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002800000000helm-docs-1.11.1/cmd/helm-docs/testdata07070100000015000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003200000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark07070100000016000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003A00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-0107070100000017000081A400000000000000000000000164C03CE400000088000000000000000000000000000000000000004500000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/Chart.yamlapiVersion: v2
name: deep-01
version: 0.1.0
dependencies:
  - name: level-3-a
    version: 0.1.0
  - name: level-3-b
    version: 0.1.0
07070100000018000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004100000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts07070100000019000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004B00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a0707010000001A000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000005600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/Chart.yamlapiVersion: v2
name: level-3-a
version: 0.1.0
dependencies:
  - name: level-2-a
    version: 0.1.0
  - name: level-2-b
    version: 0.1.0
0707010000001B000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005200000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts0707010000001C000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a0707010000001D000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
0707010000001E000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts0707010000001F000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts/level-1-a07070100000020000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000021000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000022000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts/level-1-b07070100000023000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
07070100000024000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000025000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000026000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b07070100000027000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
07070100000028000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts07070100000029000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts/level-1-a0707010000002A000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
0707010000002B000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000002C000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts/level-1-b0707010000002D000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
0707010000002E000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000002F000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/charts/level-2-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000030000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000005700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000031000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004B00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b07070100000032000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000005600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/Chart.yamlapiVersion: v2
name: level-3-b
version: 0.1.0
dependencies:
  - name: level-2-a
    version: 0.1.0
  - name: level-2-b
    version: 0.1.0
07070100000033000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005200000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts07070100000034000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a07070100000035000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
07070100000036000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts07070100000037000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts/level-1-a07070100000038000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000039000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000003A000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts/level-1-b0707010000003B000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
0707010000003C000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000003D000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000003E000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b0707010000003F000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
07070100000040000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts07070100000041000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts/level-1-a07070100000042000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000043000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000044000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts/level-1-b07070100000045000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
07070100000046000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000047000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/charts/level-2-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000048000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000005700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/charts/level-3-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000049000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000004600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-01/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000004A000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003A00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-020707010000004B000081A400000000000000000000000164C03CE400000088000000000000000000000000000000000000004500000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/Chart.yamlapiVersion: v2
name: deep-02
version: 0.1.0
dependencies:
  - name: level-3-a
    version: 0.1.0
  - name: level-3-b
    version: 0.1.0
0707010000004C000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004100000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts0707010000004D000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004B00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a0707010000004E000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000005600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/Chart.yamlapiVersion: v2
name: level-3-a
version: 0.1.0
dependencies:
  - name: level-2-a
    version: 0.1.0
  - name: level-2-b
    version: 0.1.0
0707010000004F000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005200000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts07070100000050000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a07070100000051000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
07070100000052000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts07070100000053000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts/level-1-a07070100000054000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000055000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000056000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts/level-1-b07070100000057000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
07070100000058000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000059000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000005A000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b0707010000005B000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
0707010000005C000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts0707010000005D000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts/level-1-a0707010000005E000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
0707010000005F000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000060000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts/level-1-b07070100000061000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
07070100000062000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000063000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/charts/level-2-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000064000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000005700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000065000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004B00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b07070100000066000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000005600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/Chart.yamlapiVersion: v2
name: level-3-b
version: 0.1.0
dependencies:
  - name: level-2-a
    version: 0.1.0
  - name: level-2-b
    version: 0.1.0
07070100000067000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005200000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts07070100000068000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a07070100000069000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
0707010000006A000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts0707010000006B000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts/level-1-a0707010000006C000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
0707010000006D000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000006E000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts/level-1-b0707010000006F000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
07070100000070000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000071000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000072000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b07070100000073000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
07070100000074000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts07070100000075000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts/level-1-a07070100000076000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000077000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000078000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts/level-1-b07070100000079000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
0707010000007A000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000007B000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/charts/level-2-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000007C000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000005700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/charts/level-3-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000007D000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000004600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-02/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000007E000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003A00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-030707010000007F000081A400000000000000000000000164C03CE400000088000000000000000000000000000000000000004500000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/Chart.yamlapiVersion: v2
name: deep-03
version: 0.1.0
dependencies:
  - name: level-3-a
    version: 0.1.0
  - name: level-3-b
    version: 0.1.0
07070100000080000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004100000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts07070100000081000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004B00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a07070100000082000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000005600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/Chart.yamlapiVersion: v2
name: level-3-a
version: 0.1.0
dependencies:
  - name: level-2-a
    version: 0.1.0
  - name: level-2-b
    version: 0.1.0
07070100000083000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005200000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts07070100000084000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a07070100000085000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
07070100000086000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts07070100000087000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts/level-1-a07070100000088000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000089000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000008A000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts/level-1-b0707010000008B000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
0707010000008C000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000008D000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
0707010000008E000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b0707010000008F000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
07070100000090000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts07070100000091000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts/level-1-a07070100000092000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
07070100000093000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000094000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts/level-1-b07070100000095000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
07070100000096000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000097000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/charts/level-2-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000098000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000005700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000099000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004B00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b0707010000009A000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000005600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/Chart.yamlapiVersion: v2
name: level-3-b
version: 0.1.0
dependencies:
  - name: level-2-a
    version: 0.1.0
  - name: level-2-b
    version: 0.1.0
0707010000009B000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005200000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts0707010000009C000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a0707010000009D000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
0707010000009E000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts0707010000009F000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts/level-1-a070701000000A0000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
070701000000A1000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000A2000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts/level-1-b070701000000A3000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000A4000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000A5000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000A6000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b070701000000A7000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
070701000000A8000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts070701000000A9000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts/level-1-a070701000000AA000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
070701000000AB000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000AC000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts/level-1-b070701000000AD000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000AE000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000AF000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/charts/level-2-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000B0000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000005700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/charts/level-3-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000B1000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000004600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-03/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000B2000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003A00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04070701000000B3000081A400000000000000000000000164C03CE400000088000000000000000000000000000000000000004500000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/Chart.yamlapiVersion: v2
name: deep-04
version: 0.1.0
dependencies:
  - name: level-3-a
    version: 0.1.0
  - name: level-3-b
    version: 0.1.0
070701000000B4000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004100000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts070701000000B5000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004B00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a070701000000B6000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000005600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/Chart.yamlapiVersion: v2
name: level-3-a
version: 0.1.0
dependencies:
  - name: level-2-a
    version: 0.1.0
  - name: level-2-b
    version: 0.1.0
070701000000B7000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005200000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts070701000000B8000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a070701000000B9000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
070701000000BA000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts070701000000BB000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts/level-1-a070701000000BC000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
070701000000BD000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000BE000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts/level-1-b070701000000BF000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000C0000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000C1000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000C2000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b070701000000C3000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
070701000000C4000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts070701000000C5000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts/level-1-a070701000000C6000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
070701000000C7000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000C8000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts/level-1-b070701000000C9000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000CA000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000CB000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/charts/level-2-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000CC000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000005700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000CD000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004B00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b070701000000CE000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000005600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/Chart.yamlapiVersion: v2
name: level-3-b
version: 0.1.0
dependencies:
  - name: level-2-a
    version: 0.1.0
  - name: level-2-b
    version: 0.1.0
070701000000CF000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005200000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts070701000000D0000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a070701000000D1000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/Chart.yamlapiVersion: v2
name: level-2-a
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
070701000000D2000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts070701000000D3000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts/level-1-a070701000000D4000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
070701000000D5000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000D6000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts/level-1-b070701000000D7000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000D8000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000D9000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000DA000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000005C00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b070701000000DB000081A400000000000000000000000164C03CE40000008A000000000000000000000000000000000000006700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/Chart.yamlapiVersion: v2
name: level-2-b
version: 0.1.0
dependencies:
  - name: level-1-a
    version: 0.1.0
  - name: level-1-b
    version: 0.1.0
070701000000DC000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006300000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts070701000000DD000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts/level-1-a070701000000DE000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts/level-1-a/Chart.yamlapiVersion: v2
name: level-1-a
version: 0.1.0
070701000000DF000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts/level-1-a/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000E0000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000006D00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts/level-1-b070701000000E1000081A400000000000000000000000164C03CE40000002E000000000000000000000000000000000000007800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts/level-1-b/Chart.yamlapiVersion: v2
name: level-1-b
version: 0.1.0
070701000000E2000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000007900000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/charts/level-1-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000E3000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000006800000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/charts/level-2-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000E4000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000005700000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/charts/level-3-b/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000E5000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000004600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/deep-04/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000E6000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003A00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/flat-01070701000000E7000081A400000000000000000000000164C03CE40000002C000000000000000000000000000000000000004500000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/flat-01/Chart.yamlapiVersion: v2
name: flat-01
version: 0.1.0
070701000000E8000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000004600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/flat-01/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000E9000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003A00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/flat-02070701000000EA000081A400000000000000000000000164C03CE40000002C000000000000000000000000000000000000004500000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/flat-02/Chart.yamlapiVersion: v2
name: flat-02
version: 0.1.0
070701000000EB000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000004600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/flat-02/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000EC000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003A00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/flat-03070701000000ED000081A400000000000000000000000164C03CE40000002C000000000000000000000000000000000000004500000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/flat-03/Chart.yamlapiVersion: v2
name: flat-03
version: 0.1.0
070701000000EE000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000004600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/flat-03/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000EF000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003A00000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/flat-04070701000000F0000081A400000000000000000000000164C03CE40000002C000000000000000000000000000000000000004500000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/flat-04/Chart.yamlapiVersion: v2
name: flat-04
version: 0.1.0
070701000000F1000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000004600000000helm-docs-1.11.1/cmd/helm-docs/testdata/benchmark/flat-04/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000F2000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002000000000helm-docs-1.11.1/example-charts070701000000F3000081A400000000000000000000000164C03CE4000000C7000000000000000000000000000000000000003200000000helm-docs-1.11.1/example-charts/_templates.gotmpl{{ define "extra.flower" -}}
```
          ,-.
 ,     ,-.   ,-.
/ \   (   )-(   )
\ |  ,.>-(   )-<
 \|,' (   )-(   )
  Y ___`-'   `-'
  |/__/   `-'
  |
  |
  |    -hi-
__|_____________
```
{{- end }}070701000000F4000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003400000000helm-docs-1.11.1/example-charts/best-values-example070701000000F5000081A400000000000000000000000164C03CE4000001CD000000000000000000000000000000000000003F00000000helm-docs-1.11.1/example-charts/best-values-example/Chart.yamlapiVersion: v2
name: best-values-example
description: One of the best values parsing example charts here, exhibits several more complicated examples
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/best-values-example"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/best-values-example"]
engine: gotpl
type: application
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
070701000000F6000081A400000000000000000000000164C03CE40000078C000000000000000000000000000000000000003E00000000helm-docs-1.11.1/example-charts/best-values-example/README.md# best-values-example

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

One of the best values parsing example charts here, exhibits several more complicated examples

**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/best-values-example>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> |  |

## Source Code

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/best-values-example>

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| config.databasesToCreate[0] | string | `"postgresql"` | default database for storage of database metadata |
| config.databasesToCreate[1] | string | `"hashbash"` | database for the [hashbash](https://github.com/norwoodj/hashbash) project |
| config.usersToCreate[0] | object | `{"admin":true,"name":"root"}` | admin user |
| config.usersToCreate[1] | object | `{"name":"hashbash","readwriteDatabases":["hashbash"]}` | user with access to the database with the same name |
| statefulset.extraVolumes | list | `[{"emptyDir":{},"name":"data"}]` | Additional volumes to be mounted into the database container |
| statefulset.image.repository | string | `"jnorwood/postgresq"` | Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files |
| statefulset.image.tag | string | `"11"` |  |
| statefulset.livenessProbe | object | `{"enabled":false}` | Configure the healthcheck for the database |
| statefulset.podLabels | object | `{}` | The labels to be applied to instances of the database |

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
070701000000F8000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003000000000helm-docs-1.11.1/example-charts/custom-template070701000000F9000081A400000000000000000000000164C03CE4000001B9000000000000000000000000000000000000003B00000000helm-docs-1.11.1/example-charts/custom-template/Chart.yamlapiVersion: v1
name: custom-template
description: Basically the same as the nginx-ingress chart, but using a custom template to include some other content
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/custom-template"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/custom-template"]
engine: gotpl
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
070701000000FA000081A400000000000000000000000164C03CE400000A6E000000000000000000000000000000000000003A00000000helm-docs-1.11.1/example-charts/custom-template/README.md# custom-template

Basically the same as the nginx-ingress chart, but using a custom template to include some other content

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)

## Additional Information

```
          ,-.
 ,     ,-.   ,-.
/ \   (   )-(   )
\ |  ,.>-(   )-<
 \|,' (   )-(   )
  Y ___`-'   `-'
  |/__/   `-'
  |
  |
  |    -hi-
__|_____________
```

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
culpa qui officia deserunt mollit anim id est laborum.

## Installing the Chart

To install the chart with the release name `my-release`:

```console
$ helm repo add foo-bar http://charts.foo-bar.com
$ helm install my-release foo-bar/custom-template
```

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes[0].configMap.name | string | `"nginx-ingress-config"` | Uses the name of the configmap created by this chart |
| controller.extraVolumes[0].name | string | `"config-volume"` |  |
| controller.image.repository | string | `"nginx-ingress-controller"` |  |
| controller.image.tag | string | `"18.0831"` |  |
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
| controller.name | string | `"controller"` |  |
| controller.persistentVolumeClaims | list | the chart will construct this list internally unless specified | List of persistent volume claims to create. For very long comments, break them into multiple lines. |
| controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` |  |

## Additional Information

## Installing the Chart

To install the chart with the release name `my-release`:

```console
$ helm repo add foo-bar http://charts.foo-bar.com
$ helm install my-release foo-bar/{{ template "chart.name" . }}
```

{{ template "helm-docs.versionFooter" . }}
070701000000FC000081A400000000000000000000000164C03CE400000056000000000000000000000000000000000000004200000000helm-docs-1.11.1/example-charts/custom-template/requirements.yamldependencies:
  - name: nginx-ingress
    version: "0.22.1"
    repository: "@stable"
070701000000FD000081A400000000000000000000000164C03CE400000403000000000000000000000000000000000000003C00000000helm-docs-1.11.1/example-charts/custom-template/values.yamlcontroller:
  name: controller
  image:
    repository: nginx-ingress-controller
    tag: "18.0831"

# -- List of persistent volume claims to create.
  # For very long comments, break them into multiple lines.
  # @default -- the chart will construct this list internally unless specified
  persistentVolumeClaims: []

extraVolumes:
    - name: config-volume
      configMap:
        # -- Uses the name of the configmap created by this chart
        name: nginx-ingress-config

# -- Name of the ingress class to route through this controller
  ingressClass: nginx

# -- The labels to be applied to instances of the controller pod
  podLabels: {}

publishService:
    # -- Whether to expose the ingress controller to the public world
    enabled: false

# -- (int) Number of nginx-ingress pods to load balance between
  replicas:

service:
    annotations:
      # -- Hostname to be assigned to the ELB for the service
      external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com

type: LoadBalancer
070701000000FE000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003B00000000helm-docs-1.11.1/example-charts/custom-value-notation-type070701000000FF000081A400000000000000000000000164C03CE400000299000000000000000000000000000000000000004600000000helm-docs-1.11.1/example-charts/custom-value-notation-type/Chart.yamlapiVersion: v2
name: django
version: 0.2.1
appVersion: 3.1
description: Generic chart for basic Django-based web app
keywords:
  - Django
  - Web
home: https://www.djangoproject.com/
sources:
  - https://github.com/django/django
maintainers:
  - name: Rizky Maulana Nugraha
    email: lana.pcfre@gmail.com
icon: https://raw.githubusercontent.com/kartoza/charts/master/assets/logo/django.png
engine: gotpl
dependencies:
  - name: postgis
    version: 0.2.1
    repository: "file://../../postgis/v0.2.1"
    condition: postgis.enabled
    tags:
      - database-backend
      - postgis
  - name: common
    version: 1.0.0
    repository: "file://../../common/v1.0.0"
07070100000100000081A400000000000000000000000164C03CE4000066F5000000000000000000000000000000000000004500000000helm-docs-1.11.1/example-charts/custom-value-notation-type/README.md# django

![Version: 0.2.1](https://img.shields.io/badge/Version-0.2.1-informational?style=flat-square) ![AppVersion: 3.1](https://img.shields.io/badge/AppVersion-3.1-informational?style=flat-square)

Generic chart for basic Django-based web app

**Homepage:** <https://www.djangoproject.com/>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Rizky Maulana Nugraha | <lana.pcfre@gmail.com> |  |

## Source Code

* <https://github.com/django/django>

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| file://../../common/v1.0.0 | common | 1.0.0 |
| file://../../postgis/v0.2.1 | postgis | 0.2.1 |

# Some Long Description

This is a sample README with custom overrides.
Check the template in [README.md.gotmpl](README.md.gotmpl).

In that file, we redefine the template definition of `chart.valueDefaultColumnRender`
for some custom `@notationType` such as `string/email`.

This chart README uses `chart.valuesSectionHtml` instead of `chart.valuesSection`.
Using HTML table directly instead of using Markdown table allows us to control the table
presentation, such as the height. This is especially useful for very long `values.yaml` file,
and you need to scroll both horizontally and vertically to navigate the values.

In the template file, we redefine `chart.valuesTableHtml` so that we use table height of
400px at most. Github can understand that attribute. The more sophisticated use case is if you
want to combine helm-docs with a Jamstack static generator where you can have your own page generated
from this README.

The customization can goes even further. Normally, you can't define anchor in markdown unless it is a heading. But you can do so easily using HTML tags.
You can override the column key renderer by adding an `id` attribute so that it can be referred.
This way, when you write markdown links like [ingress.tls.secretName](#ingress--tls--secretName), clicking the link
will take you to the value description row.

## Value Types

One of the benefit of using HTML table is we can make a simple tooltip and anchor.
For example, the value [global.adminEmail](#global--adminEmail) is annotated as type `string/email`. We create
the definition of the value type here and can be anchored by links with `#stringemail` hyperlinks.

We can also create custom type column renderer, where we can assign a tooltip for each type.
Try this out. Go navigate to [global.adminEmail](#global--adminEmail) value, hover on the value type `string/email`, you will then see
some tooltip. Clicking the type link will direct you back to it's relevant value type section below.

Other useful case is If the type is a known type, like
Kubernetes service type, you can anchor the type to redirect user to k8s documentation page to learn more.
Check the value [persistence.staticDir.accessModes](#persistence--staticDir--accessModes)

### string/email

This value type is for a valid email address format. Such as owner@somedomain.org.

## Notation Type

Another reason to use HTML table is because in some cases we want to custom-render the default value.

In helm chart templates, sometimes author designs the template to accept a go template string value.
That means, the template string can be processed by helm chart and be replaced with dynamic computed values, before it was
rendered to the chart. Although it is very useful and flexible to make the default value be dynamic,
it is not entirely obvious for the chart users to see a go template as value in a `values.yml`.
It would then be helpful to custom-render these default values in the helm README, so that it is not
treated as a pure JSON object (because the syntax highlighter would be incorrect).
Instead we can custom render the presentation so it would make sense to the user.

In our example here, any key with a type `tpl/xxx` would be rendered as `<pre></pre>`
HTML tag, in which we both put the key name and the YAML multiline modifier `|` to make
it really clear that the key accept a multiline string as value, because it would be rendered as
YAML object by helm after the values are interpolated/substituted.

Take a look at [extraPodEnv](#extraPodEnv). The `Default` column shows the key name `extraPodEnv`, the multiline YAML
modifier `|`, and the template string which contains some go string template syntax `{{ }}`.

You can also control the HTML styling directly. In some markdown viewer, the HTML tag and inline styles
are respected, so the custom styles can be seen. Combined with a Jamstack approach, you can
design your template to also incorporate some custom React styles or simple CSS.

In our example here, [global.adminEmail](#global--adminEmail) is annotated with `email` notationType.
This allows you to insert custom rendering code for email. For supported markdown viewer, like Visual Studio Code,
the default value will have `green` color, and if clicked will direct you to your default email composer.

The reason we have two separate annotation, value type and notation type, is because several different types
can have the same type renderer. For example, any type `tpl/xxx` is a go template string, so it will be rendered the same
in our docs if we annotate it with `@notationType -- tpl`.

## Customized Rendering

This README also shows some possible customization with helm-docs. In the [README.md.gotmpl](README.md.gotmpl)
file, you can see that we modified the column `Key` to also be hyperlinked with the definition in `values.yaml`.
If you view this README.md files in GitHub and click the value's key, you will be directed to the
key location in the `values.yaml` file.

You can also render a raw string into the comments using `@raw` annotations.
You can jump to [sampleYaml](#sampleYaml) key and check it's description where it
uses HTML `<summary>` tag to collapse some part of the comments.

## Values

<table height="400px" >
	<thead>
		<th>Key</th>
		<th>Type</th>
		<th>Default</th>
		<th>Description</th>
	</thead>
	<tbody>
		<tr>
			<td id="extraConfigMap"><a href="./values.yaml#L111">extraConfigMap</a></td>
			<td>
tpl/dict
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
extraConfigMap: |
 
</pre>
</div>
			</td>
			<td>Define this for extra config map to be included in django-shared-config</td>
		</tr>
		<tr>
			<td id="extraPodEnv"><a href="./values.yaml#L88">extraPodEnv</a></td>
			<td>
tpl/array
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
extraPodEnv: |
  - name: DJANGO_SETTINGS_MODULE
    value: "django.settings"
  - name: DEBUG
    value: {{ .Values.global.debug | quote }}
  - name: ROOT_URLCONF
    value: {{ .Values.global.rootURLConf | quote }}
  - name: MAIN_APP_NAME
    value: {{ .Values.global.mainAppName | quote }}
 
</pre>
</div>
			</td>
			<td>Define this for extra Django environment variables</td>
		</tr>
		<tr>
			<td id="extraPodSpec"><a href="./values.yaml#L100">extraPodSpec</a></td>
			<td>
tpl/object
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
extraPodSpec: |
 
</pre>
</div>
			</td>
			<td>This will be evaluated as pod spec</td>
		</tr>
		<tr>
			<td id="extraSecret"><a href="./values.yaml#L106">extraSecret</a></td>
			<td>
tpl/dict
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
extraSecret: |
 
</pre>
</div>
			</td>
			<td>Define this for extra secrets to be included in django-shared-secret secret</td>
		</tr>
		<tr>
			<td id="extraVolume"><a href="./values.yaml#L125">extraVolume</a></td>
			<td>
tpl/array
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
extraVolume: |
 
</pre>
</div>
			</td>
			<td>Define this for extra volume (in pair with extraVolumeMounts)</td>
		</tr>
		<tr>
			<td id="extraVolumeMounts"><a href="./values.yaml#L116">extraVolumeMounts</a></td>
			<td>
tpl/array
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
extraVolumeMounts: |
 
</pre>
</div>
			</td>
			<td>Define this for extra volume mounts in the pod</td>
		</tr>
		<tr>
			<td id="global"><a href="./values.yaml#L14">global</a></td>
			<td>
object
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
{
  "adminEmail": "admin@localhost",
  "adminPassword": {
    "value": null,
    "valueFrom": {
      "secretKeyRef": {
        "key": "admin-password",
        "name": null
      }
    }
  },
  "adminUser": "admin",
  "databaseHost": "postgis",
  "databaseName": "django",
  "databasePassword": {
    "value": null,
    "valueFrom": {
      "secretKeyRef": {
        "key": "database-password",
        "name": null
      }
    }
  },
  "databasePort": 5432,
  "databaseUsername": "django_db_user",
  "debug": "False",
  "djangoArgs": "[\"uwsgi\",\"--chdir=${REPO_ROOT}\",\"--module=${MAIN_APP_NAME}.wsgi\",\"--socket=:8000\",\"--http=0.0.0.0:8080\",\"--processes=5\",\"--buffer-size=8192\"]\n",
  "djangoCommand": "[\"/opt/django/scripts/docker-entrypoint.sh\"]\n",
  "djangoSecretKey": {
    "value": null,
    "valueFrom": {
      "secretKeyRef": {
        "key": "django-secret",
        "name": null
      }
    }
  },
  "djangoSettingsModule": "django.settings",
  "existingSecret": "",
  "mainAppName": "django",
  "mediaRoot": "/opt/django/media",
  "nameOverride": "django",
  "rootURLConf": "django.urls",
  "sharedSecretName": "django-shared-secret",
  "siteName": "django",
  "staticRoot": "/opt/django/static"
}
</pre>
</div>
			</td>
			<td>This key name is used for service interconnection between subcharts and parent charts.</td>
		</tr>
		<tr>
			<td id="global--adminEmail"><a href="./values.yaml#L43">global.adminEmail</a></td>
			<td>
<a href="#stringemail" title="
This value type is for a valid email address format. Such as owner@somedomain.org.">string/email</a>
</td>
			<td>
				<div style="max-width: 300px;">
<a href="mailto:admin@localhost" style="color: green;">"admin@localhost"</a>
</div>
			</td>
			<td>Default admin email sender</td>
		</tr>
		<tr>
			<td id="global--adminPassword--value"><a href="./values.yaml#L36">global.adminPassword.value</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
null
</pre>
</div>
			</td>
			<td>Specify this password value. If not, it will be autogenerated everytime chart upgraded</td>
		</tr>
		<tr>
			<td id="global--adminUser"><a href="./values.yaml#L33">global.adminUser</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"admin"
</pre>
</div>
			</td>
			<td>Default super user admin username</td>
		</tr>
		<tr>
			<td id="global--databaseHost"><a href="./values.yaml#L63">global.databaseHost</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"postgis"
</pre>
</div>
			</td>
			<td>Django database host location. By default this chart can generate standard postgres chart. So you can leave it as default. If you use external backend,  you must provide the value</td>
		</tr>
		<tr>
			<td id="global--databaseName"><a href="./values.yaml#L61">global.databaseName</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"django"
</pre>
</div>
			</td>
			<td>Django database name</td>
		</tr>
		<tr>
			<td id="global--databasePassword--value"><a href="./values.yaml#L55">global.databasePassword.value</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
null
</pre>
</div>
			</td>
			<td>Specify this password value. If not, it will be autogenerated everytime chart upgraded. If you use external backend, you must provide the value</td>
		</tr>
		<tr>
			<td id="global--databasePort"><a href="./values.yaml#L65">global.databasePort</a></td>
			<td>
int
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
5432
</pre>
</div>
			</td>
			<td>Django database port. By default this chart can generate standard postgres chart. So you can leave it as default. If you use external backend,  you must provide the value</td>
		</tr>
		<tr>
			<td id="global--databaseUsername"><a href="./values.yaml#L52">global.databaseUsername</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"django_db_user"
</pre>
</div>
			</td>
			<td>Database username backend to connect to. If you use external backend, provide the value</td>
		</tr>
		<tr>
			<td id="global--debug"><a href="./values.yaml#L67">global.debug</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"False"
</pre>
</div>
			</td>
			<td>Python boolean literal, this will correspond to `DEBUG` environment variable inside the Django container. Useful as a debug switch.</td>
		</tr>
		<tr>
			<td id="global--djangoArgs"><a href="./values.yaml#L30">global.djangoArgs</a></td>
			<td>
tpl/array
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
global.djangoArgs: |
  ["uwsgi","--chdir=${REPO_ROOT}","--module=${MAIN_APP_NAME}.wsgi","--socket=:8000","--http=0.0.0.0:8080","--processes=5","--buffer-size=8192"]
 
</pre>
</div>
			</td>
			<td>The django command args to be passed to entrypoint command</td>
		</tr>
		<tr>
			<td id="global--djangoCommand"><a href="./values.yaml#L26">global.djangoCommand</a></td>
			<td>
tpl/array
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
global.djangoCommand: |
  ["/opt/django/scripts/docker-entrypoint.sh"]
 
</pre>
</div>
			</td>
			<td>The django entrypoint command to execute</td>
		</tr>
		<tr>
			<td id="global--djangoSecretKey--value"><a href="./values.yaml#L46">global.djangoSecretKey.value</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
null
</pre>
</div>
			</td>
			<td>Specify this Django Secret string value. If not, it will be autogenerated everytime chart upgraded</td>
		</tr>
		<tr>
			<td id="global--djangoSettingsModule"><a href="./values.yaml#L71">global.djangoSettingsModule</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"django.settings"
</pre>
</div>
			</td>
			<td>Django settings module to be used</td>
		</tr>
		<tr>
			<td id="global--existingSecret"><a href="./values.yaml#L18">global.existingSecret</a></td>
			<td>
tpl/string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
global.existingSecret: |
 
</pre>
</div>
			</td>
			<td>Name of existing secret</td>
		</tr>
		<tr>
			<td id="global--mainAppName"><a href="./values.yaml#L69">global.mainAppName</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"django"
</pre>
</div>
			</td>
			<td>The main app name to execute. Affects which settings, wsgi, and rootURL to use.</td>
		</tr>
		<tr>
			<td id="global--mediaRoot"><a href="./values.yaml#L77">global.mediaRoot</a></td>
			<td>
path
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"/opt/django/media"
</pre>
</div>
			</td>
			<td>Location to the media directory</td>
		</tr>
		<tr>
			<td id="global--rootURLConf"><a href="./values.yaml#L73">global.rootURLConf</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"django.urls"
</pre>
</div>
			</td>
			<td>Django root URL conf to be used</td>
		</tr>
		<tr>
			<td id="global--sharedSecretName"><a href="./values.yaml#L20">global.sharedSecretName</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"django-shared-secret"
</pre>
</div>
			</td>
			<td>Name of shared secret store that will be generated</td>
		</tr>
		<tr>
			<td id="global--siteName"><a href="./values.yaml#L23">global.siteName</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"django"
</pre>
</div>
			</td>
			<td>The site name. It will be used to construct url such as http://django/</td>
		</tr>
		<tr>
			<td id="global--staticRoot"><a href="./values.yaml#L75">global.staticRoot</a></td>
			<td>
path
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"/opt/django/static"
</pre>
</div>
			</td>
			<td>Location to the static directory</td>
		</tr>
		<tr>
			<td id="image"><a href="./values.yaml#L2">image</a></td>
			<td>
object
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
{
  "pullPolicy": "IfNotPresent",
  "registry": "docker.io",
  "repository": "lucernae/django-sample",
  "tag": "3.1"
}
</pre>
</div>
			</td>
			<td>Image map</td>
		</tr>
		<tr>
			<td id="image--pullPolicy"><a href="./values.yaml#L10">image.pullPolicy</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"IfNotPresent"
</pre>
</div>
			</td>
			<td>Image pullPolicy</td>
		</tr>
		<tr>
			<td id="image--registry"><a href="./values.yaml#L4">image.registry</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"docker.io"
</pre>
</div>
			</td>
			<td>Image registry</td>
		</tr>
		<tr>
			<td id="image--repository"><a href="./values.yaml#L6">image.repository</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"lucernae/django-sample"
</pre>
</div>
			</td>
			<td>Image repository</td>
		</tr>
		<tr>
			<td id="image--tag"><a href="./values.yaml#L8">image.tag</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"3.1"
</pre>
</div>
			</td>
			<td>Image tag</td>
		</tr>
		<tr>
			<td id="ingress--annotations"><a href="./values.yaml#L155">ingress.annotations</a></td>
			<td>
dict
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
{}
</pre>
</div>
			</td>
			<td>Custom Ingress annotations</td>
		</tr>
		<tr>
			<td id="ingress--enabled"><a href="./values.yaml#L150">ingress.enabled</a></td>
			<td>
bool
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
false
</pre>
</div>
			</td>
			<td>Set to true to generate Ingress resource</td>
		</tr>
		<tr>
			<td id="ingress--host"><a href="./values.yaml#L153">ingress.host</a></td>
			<td>
tpl/string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
ingress.host: |
 
</pre>
</div>
			</td>
			<td>Set custom host name. (DNS name convention)</td>
		</tr>
		<tr>
			<td id="ingress--labels"><a href="./values.yaml#L157">ingress.labels</a></td>
			<td>
dict
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
{}
</pre>
</div>
			</td>
			<td>Custom Ingress labels</td>
		</tr>
		<tr>
			<td id="ingress--tls--enabled"><a href="./values.yaml#L160">ingress.tls.enabled</a></td>
			<td>
bool
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
false
</pre>
</div>
			</td>
			<td>Set to true to enable HTTPS</td>
		</tr>
		<tr>
			<td id="ingress--tls--secretName"><a href="./values.yaml#L162">ingress.tls.secretName</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"django-tls"
</pre>
</div>
			</td>
			<td>You must provide a secret name where the TLS cert is stored</td>
		</tr>
		<tr>
			<td id="labels"><a href="./values.yaml#L81">labels</a></td>
			<td>
map
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="yaml">
user/workload: "true"
client-name: "my-boss"
project-name: "awesome-project"

</pre>
</div>
			</td>
			<td>The deployment label</td>
		</tr>
		<tr>
			<td id="persistence--mediaDir--accessModes[0]"><a href="./values.yaml#L199">persistence.mediaDir.accessModes[0]</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"ReadWriteOnce"
</pre>
</div>
			</td>
			<td></td>
		</tr>
		<tr>
			<td id="persistence--mediaDir--annotations"><a href="./values.yaml#L200">persistence.mediaDir.annotations</a></td>
			<td>
object
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
{}
</pre>
</div>
			</td>
			<td></td>
		</tr>
		<tr>
			<td id="persistence--mediaDir--enabled"><a href="./values.yaml#L193">persistence.mediaDir.enabled</a></td>
			<td>
bool
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
true
</pre>
</div>
			</td>
			<td>Allow persistence</td>
		</tr>
		<tr>
			<td id="persistence--mediaDir--existingClaim"><a href="./values.yaml#L194">persistence.mediaDir.existingClaim</a></td>
			<td>
bool
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
false
</pre>
</div>
			</td>
			<td></td>
		</tr>
		<tr>
			<td id="persistence--mediaDir--mountPath"><a href="./values.yaml#L195">persistence.mediaDir.mountPath</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"/opt/django/media"
</pre>
</div>
			</td>
			<td></td>
		</tr>
		<tr>
			<td id="persistence--mediaDir--size"><a href="./values.yaml#L197">persistence.mediaDir.size</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"8Gi"
</pre>
</div>
			</td>
			<td></td>
		</tr>
		<tr>
			<td id="persistence--mediaDir--subPath"><a href="./values.yaml#L196">persistence.mediaDir.subPath</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"media"
</pre>
</div>
			</td>
			<td></td>
		</tr>
		<tr>
			<td id="persistence--staticDir--accessModes"><a href="./values.yaml#L188">persistence.staticDir.accessModes</a></td>
			<td>
<a target="_blank"
   href="https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes"
   >k8s/storage/persistent-volume/access-modes</a>
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="yaml">
- ReadWriteOnce

</pre>
</div>
			</td>
			<td>Static Dir access modes</td>
		</tr>
		<tr>
			<td id="persistence--staticDir--annotations"><a href="./values.yaml#L190">persistence.staticDir.annotations</a></td>
			<td>
object
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
{}
</pre>
</div>
			</td>
			<td></td>
		</tr>
		<tr>
			<td id="persistence--staticDir--enabled"><a href="./values.yaml#L181">persistence.staticDir.enabled</a></td>
			<td>
bool
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
true
</pre>
</div>
			</td>
			<td>Allow persistence</td>
		</tr>
		<tr>
			<td id="persistence--staticDir--existingClaim"><a href="./values.yaml#L182">persistence.staticDir.existingClaim</a></td>
			<td>
bool
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
false
</pre>
</div>
			</td>
			<td></td>
		</tr>
		<tr>
			<td id="persistence--staticDir--mountPath"><a href="./values.yaml#L183">persistence.staticDir.mountPath</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"/opt/django/static"
</pre>
</div>
			</td>
			<td></td>
		</tr>
		<tr>
			<td id="persistence--staticDir--size"><a href="./values.yaml#L185">persistence.staticDir.size</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"8Gi"
</pre>
</div>
			</td>
			<td></td>
		</tr>
		<tr>
			<td id="persistence--staticDir--subPath"><a href="./values.yaml#L184">persistence.staticDir.subPath</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"static"
</pre>
</div>
			</td>
			<td></td>
		</tr>
		<tr>
			<td id="postgis--enabled"><a href="./values.yaml#L170">postgis.enabled</a></td>
			<td>
bool
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
true
</pre>
</div>
			</td>
			<td>Enable postgis as database backend by default. Set to false if using different external backend.</td>
		</tr>
		<tr>
			<td id="postgis--existingSecret"><a href="./values.yaml#L174">postgis.existingSecret</a></td>
			<td>
tpl/string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
postgis.existingSecret: |
  {{ include "common.sharedSecretName" . | quote -}}
 
</pre>
</div>
			</td>
			<td>Existing secret to be used</td>
		</tr>
		<tr>
			<td id="probe"><a href="./values.yaml#L166">probe</a></td>
			<td>
tpl/object
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
probe: |
 
</pre>
</div>
			</td>
			<td>Probe can be overridden</td>
		</tr>
		<tr>
			<td id="sampleYaml"><a href="./values.yaml#L227">sampleYaml</a></td>
			<td>
dict
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
{}
</pre>
</div>
			</td>
			<td>Values with long description
Sometimes you need a very long description
for your values.

Any comment section for a given key with **@raw** attribute
will be treated as raw string and stored as is.
Since it generates in Markdown format, you can do something like this:

```yaml
hello:
  bar: true
```

Markdown also accept subset of HTML tags. So you can also do this:

<details>
<summary>+Expand</summary>

```bash
execute some command
```

</details></td>
		</tr>
		<tr>
			<td id="service--annotations"><a href="./values.yaml#L146">service.annotations</a></td>
			<td>
dict
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
{}
</pre>
</div>
			</td>
			<td>Extra service annotations</td>
		</tr>
		<tr>
			<td id="service--clusterIP"><a href="./values.yaml#L135">service.clusterIP</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
""
</pre>
</div>
			</td>
			<td>Specify `None` for headless service. Otherwise, leave them be.</td>
		</tr>
		<tr>
			<td id="service--externalIPs"><a href="./values.yaml#L138">service.externalIPs</a></td>
			<td>
tpl/array
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="tpl">
service.externalIPs: |
 
</pre>
</div>
			</td>
			<td>Specify for LoadBalancer service type</td>
		</tr>
		<tr>
			<td id="service--nodePort"><a href="./values.yaml#L143">service.nodePort</a></td>
			<td>
int
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
null
</pre>
</div>
			</td>
			<td>Specify node port, for NodePort service type</td>
		</tr>
		<tr>
			<td id="service--port"><a href="./values.yaml#L140">service.port</a></td>
			<td>
int
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
80
</pre>
</div>
			</td>
			<td>Specify service port</td>
		</tr>
		<tr>
			<td id="service--type"><a href="./values.yaml#L133">service.type</a></td>
			<td>
string
</td>
			<td>
				<div style="max-width: 300px;">
<pre lang="json">
"ClusterIP"
</pre>
</div>
			</td>
			<td>Define k8s service for Django.</td>
		</tr>
	</tbody>
</table>

# Some Long Description

This is a sample README with custom overrides.
Check the template in [README.md.gotmpl](README.md.gotmpl).

In that file, we redefine the template definition of `chart.valueDefaultColumnRender`
for some custom `@notationType` such as `string/email`.

This chart README uses `chart.valuesSectionHtml` instead of `chart.valuesSection`.
Using HTML table directly instead of using Markdown table allows us to control the table
presentation, such as the height. This is especially useful for very long `values.yaml` file, 
and you need to scroll both horizontally and vertically to navigate the values.

In the template file, we redefine `chart.valuesTableHtml` so that we use table height of 
400px at most. Github can understand that attribute. The more sophisticated use case is if you
want to combine helm-docs with a Jamstack static generator where you can have your own page generated 
from this README.

The customization can goes even further. Normally, you can't define anchor in markdown unless it is a heading. But you can do so easily using HTML tags. 
You can override the column key renderer by adding an `id` attribute so that it can be referred.
This way, when you write markdown links like [ingress.tls.secretName](#ingress--tls--secretName), clicking the link 
will take you to the value description row.

## Value Types

One of the benefit of using HTML table is we can make a simple tooltip and anchor.
For example, the value [global.adminEmail](#global--adminEmail) is annotated as type `string/email`. We create 
the definition of the value type here and can be anchored by links with `#stringemail` hyperlinks.

We can also create custom type column renderer, where we can assign a tooltip for each type.
Try this out. Go navigate to [global.adminEmail](#global--adminEmail) value, hover on the value type `string/email`, you will then see 
some tooltip. Clicking the type link will direct you back to it's relevant value type section below.

Other useful case is If the type is a known type, like 
Kubernetes service type, you can anchor the type to redirect user to k8s documentation page to learn more. 
Check the value [persistence.staticDir.accessModes](#persistence--staticDir--accessModes)

### string/email

{{- define "chart.valuetypes.email" }}
This value type is for a valid email address format. Such as owner@somedomain.org.
{{- end }}
{{ template "chart.valuetypes.email" . }}

## Notation Type

Another reason to use HTML table is because in some cases we want to custom-render the default value.

In helm chart templates, sometimes author designs the template to accept a go template string value.
That means, the template string can be processed by helm chart and be replaced with dynamic computed values, before it was 
rendered to the chart. Although it is very useful and flexible to make the default value be dynamic,
it is not entirely obvious for the chart users to see a go template as value in a `values.yml`.
It would then be helpful to custom-render these default values in the helm README, so that it is not 
treated as a pure JSON object (because the syntax highlighter would be incorrect).
Instead we can custom render the presentation so it would make sense to the user.

In our example here, any key with a type `tpl/xxx` would be rendered as `<pre></pre>` 
HTML tag, in which we both put the key name and the YAML multiline modifier `|` to make 
it really clear that the key accept a multiline string as value, because it would be rendered as 
YAML object by helm after the values are interpolated/substituted.

Take a look at [extraPodEnv](#extraPodEnv). The `Default` column shows the key name `extraPodEnv`, the multiline YAML 
modifier `|`, and the template string which contains some go string template syntax `{{"{{ }}"}}`.

You can also control the HTML styling directly. In some markdown viewer, the HTML tag and inline styles 
are respected, so the custom styles can be seen. Combined with a Jamstack approach, you can 
design your template to also incorporate some custom React styles or simple CSS.

In our example here, [global.adminEmail](#global--adminEmail) is annotated with `email` notationType.
This allows you to insert custom rendering code for email. For supported markdown viewer, like Visual Studio Code, 
the default value will have `green` color, and if clicked will direct you to your default email composer.

The reason we have two separate annotation, value type and notation type, is because several different types 
can have the same type renderer. For example, any type `tpl/xxx` is a go template string, so it will be rendered the same 
in our docs if we annotate it with `@notationType -- tpl`.

## Customized Rendering

This README also shows some possible customization with helm-docs. In the [README.md.gotmpl](README.md.gotmpl) 
file, you can see that we modified the column `Key` to also be hyperlinked with the definition in `values.yaml`.
If you view this README.md files in GitHub and click the value's key, you will be directed to the 
key location in the `values.yaml` file.

{{ define "chart.valueDefaultColumnRender" }}
{{- $defaultValue := (default .Default .AutoDefault)  -}}
{{- $notationType := .NotationType }}
{{- if (and (hasPrefix "`" $defaultValue) (hasSuffix "`" $defaultValue) ) -}}
{{- $defaultValue = (toPrettyJson (fromJson (trimAll "`" (default .Default .AutoDefault) ) ) ) -}}
{{- $notationType = "json" }}
{{- end -}}
{{- if (eq $notationType "tpl" ) }}
<pre lang="{{ $notationType }}">
{{ .Key }}: |
{{- $defaultValue | nindent 2 }}
</pre>
{{- else if (eq $notationType "email") }}
<a href="mailto:{{ $defaultValue }}" style="color: green;">"{{ $defaultValue }}"</a>
{{- else }}
<pre lang="{{ $notationType }}">
{{ $defaultValue }}
</pre>
{{- end }}
{{ end }}

{{ define "chart.typeColumnRender" }}
{{- if (eq .Type "string/email") }}
<a href="#stringemail" title="{{- template "chart.valuetypes.email" -}}">{{.Type}}</a>
{{- else if (eq .Type "k8s/storage/persistent-volume/access-modes" )}}
<a target="_blank" 
   href="https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes"
   >{{- .Type }}</a>
{{- else }}
{{ .Type }}
{{- end }}
{{ end }}

{{ define "chart.valuesTableHtml" }}
<table height="400px" >
	<thead>
		<th>Key</th>
		<th>Type</th>
		<th>Default</th>
		<th>Description</th>
	</thead>
	<tbody>
	{{- range .Values }}
		<tr>
			<td id="{{ .Key | replace "." "--" }}"><a href="./values.yaml#L{{ .LineNumber }}">{{ .Key }}</a></td>
			<td>{{- template "chart.typeColumnRender" . -}}</td>
			<td>
				<div style="max-width: 300px;">{{ template "chart.valueDefaultColumnRender" . }}</div>
			</td>
			<td>{{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }}</td>
		</tr>
	{{- end }}
	</tbody>
</table>
{{ end }}

{{ template "helm-docs.versionFooter" . }}
07070100000102000081A400000000000000000000000164C03CE400001B5E000000000000000000000000000000000000004700000000helm-docs-1.11.1/example-charts/custom-value-notation-type/values.yaml# -- Image map
image:
  # -- Image registry
  registry: docker.io
  # -- Image repository
  repository: lucernae/django-sample
  # -- Image tag
  tag: "3.1"
  # -- Image pullPolicy
  pullPolicy: IfNotPresent

# -- This key name is used for service interconnection between subcharts and parent charts.
global:
  nameOverride: django
  # -- (tpl/string) Name of existing secret
  # @notationType -- tpl
  existingSecret: |
  # -- (string) Name of shared secret store that will be generated
  sharedSecretName: django-shared-secret
  # generic values
  # -- (string) The site name. It will be used to construct url such as http://django/
  siteName: django
  # -- (tpl/array) The django entrypoint command to execute
  # @notationType -- tpl
  djangoCommand: |
    ["/opt/django/scripts/docker-entrypoint.sh"]
  # -- (tpl/array) The django command args to be passed to entrypoint command
  # @notationType -- tpl
  djangoArgs: |
    ["uwsgi","--chdir=${REPO_ROOT}","--module=${MAIN_APP_NAME}.wsgi","--socket=:8000","--http=0.0.0.0:8080","--processes=5","--buffer-size=8192"]
  # -- (string) Default super user admin username
  adminUser: admin
  adminPassword:
    # -- (string) Specify this password value. If not, it will be autogenerated everytime chart upgraded
    value:
    valueFrom:
      secretKeyRef:
        name:
        key: admin-password
  # -- (string/email) Default admin email sender
  # @notationType -- email
  adminEmail: admin@localhost
  djangoSecretKey:
    # -- (string) Specify this Django Secret string value. If not, it will be autogenerated everytime chart upgraded
    value:
    valueFrom:
      secretKeyRef:
        name:
        key: django-secret
  # -- (string) Database username backend to connect to. If you use external backend, provide the value
  databaseUsername: django_db_user
  databasePassword:
    # -- (string) Specify this password value. If not, it will be autogenerated everytime chart upgraded. If you use external backend, you must provide the value
    value:
    valueFrom:
      secretKeyRef:
        name:
        key: database-password
  # -- (string) Django database name
  databaseName: django
  # -- (string) Django database host location. By default this chart can generate standard postgres chart. So you can leave it as default. If you use external backend,  you must provide the value
  databaseHost: postgis
  # -- (int) Django database port. By default this chart can generate standard postgres chart. So you can leave it as default. If you use external backend,  you must provide the value
  databasePort: 5432
  # -- (string) Python boolean literal, this will correspond to `DEBUG` environment variable inside the Django container. Useful as a debug switch.
  debug: "False"
  # -- (string) The main app name to execute. Affects which settings, wsgi, and rootURL to use.
  mainAppName: django
  # -- (string) Django settings module to be used
  djangoSettingsModule: django.settings
  # -- (string) Django root URL conf to be used
  rootURLConf: django.urls
  # -- (path) Location to the static directory
  staticRoot: /opt/django/static
  # -- (path) Location to the media directory
  mediaRoot: /opt/django/media

# -- (map) The deployment label
# @notationType -- yaml
labels:
  user/workload: "true"
  client-name: "my-boss"
  project-name: "awesome-project"

# -- (tpl/array) Define this for extra Django environment variables
# @notationType -- tpl
extraPodEnv: |
  - name: DJANGO_SETTINGS_MODULE
    value: "django.settings"
  - name: DEBUG
    value: {{ .Values.global.debug | quote }}
  - name: ROOT_URLCONF
    value: {{ .Values.global.rootURLConf | quote }}
  - name: MAIN_APP_NAME
    value: {{ .Values.global.mainAppName | quote }}

# -- (tpl/object) This will be evaluated as pod spec
# @notationType -- tpl
extraPodSpec: |
#  nodeSelector:
#    a.label: value

# -- (tpl/dict) Define this for extra secrets to be included in django-shared-secret secret
# @notationType -- tpl
extraSecret: |
#  key_1: value_1

# -- (tpl/dict) Define this for extra config map to be included in django-shared-config
# @notationType -- tpl
extraConfigMap: |
# file_1: conf content

# -- (tpl/array) Define this for extra volume mounts in the pod
# @notationType -- tpl
extraVolumeMounts: |
# You may potentially mount a config map/secret
#  - name: custom-config
#    mountPath: /docker-entrypoint.sh
#    subPath: docker-entrypoint.sh
#    readOnly: true

# -- (tpl/array) Define this for extra volume (in pair with extraVolumeMounts)
# @notationType -- tpl
extraVolume: |
# You may potentially mount a config map/secret
#  - name: custom-config
#    configMap:
#      name: geonode-config

service:
  # -- (string) Define k8s service for Django.
  type: ClusterIP
  # -- (string) Specify `None` for headless service. Otherwise, leave them be.
  clusterIP: ""
  # -- (tpl/array) Specify for LoadBalancer service type
  # @notationType -- tpl
  externalIPs: |
  # -- (int) Specify service port
  port: 80

# -- (int) Specify node port, for NodePort service type
  nodePort:

# -- (dict) Extra service annotations
  annotations: {}

ingress:
  # -- (bool) Set to true to generate Ingress resource
  enabled: false
  # -- (tpl/string) Set custom host name. (DNS name convention)
  # @notationType -- tpl
  host: |
  # -- (dict) Custom Ingress annotations
  annotations: {}
  # -- (dict) Custom Ingress labels
  labels: {}
  tls:
    # -- (bool) Set to true to enable HTTPS
    enabled: false
    # -- (string) You must provide a secret name where the TLS cert is stored
    secretName: django-tls

# -- (tpl/object) Probe can be overridden
# @notationType -- tpl
probe: |

postgis:
  # -- (bool) Enable postgis as database backend by default. Set to false if using different external backend.
  enabled: true

# -- (tpl/string) Existing secret to be used
  # @notationType -- tpl
  existingSecret: |
    {{ include "common.sharedSecretName" . | quote -}}

persistence:
  staticDir:
    # -- (bool) Allow persistence
    enabled: true
    existingClaim: false
    mountPath: /opt/django/static
    subPath: "static"
    size: 8Gi
    # -- (k8s/storage/persistent-volume/access-modes) Static Dir access modes
    # @notationType -- yaml
    accessModes:
      - ReadWriteOnce
    annotations: {}
  mediaDir:
    # -- (bool) Allow persistence
    enabled: true
    existingClaim: false
    mountPath: /opt/django/media
    subPath: "media"
    size: 8Gi
    accessModes:
      - ReadWriteOnce
    annotations: {}

# -- (dict) Values with long description
# @raw
# Sometimes you need a very long description
# for your values.
#
# Any comment section for a given key with **@raw** attribute
# will be treated as raw string and stored as is.
# Since it generates in Markdown format, you can do something like this:
#
# ```yaml
# hello:
#   bar: true
# ```
#
# Markdown also accept subset of HTML tags. So you can also do this:
#
# <details>
# <summary>+Expand</summary>
# 
# ```bash
# execute some command
# ```
#
# </details>
sampleYaml: {}07070100000103000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003100000000helm-docs-1.11.1/example-charts/dos-line-endings07070100000104000081A400000000000000000000000164C03CE400000174000000000000000000000000000000000000003D00000000helm-docs-1.11.1/example-charts/dos-line-endings/.helmignore# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*.orig
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
07070100000105000081A400000000000000000000000164C03CE400000495000000000000000000000000000000000000003C00000000helm-docs-1.11.1/example-charts/dos-line-endings/Chart.yamlapiVersion: v2
name: dos-line-endings
description: A chart whose values file has dos line endings rather than unix ones

# A chart can be either an 'application' or a 'library' chart.
#
# Application charts are a collection of templates that can be packaged into versioned archives
# to be deployed.
#
# Library charts provide useful utilities or functions for the chart developer. They're included as
# a dependency of application charts to inject those utilities and functions into the rendering
# pipeline. Library charts do not define any templates and therefore cannot be deployed.
type: application

# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.1.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
appVersion: 1.16.0
07070100000106000081A400000000000000000000000164C03CE400000406000000000000000000000000000000000000003B00000000helm-docs-1.11.1/example-charts/dos-line-endings/README.md# dos-line-endings

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square)

A chart whose values file has dos line endings rather than unix ones

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world sdf |
| controller.replicas | int | `2` | Number of nginx-ingress pods to load balance between sdf. Do not set this below 2. |
| livenessProbe.httpGet.path | string | `"/healthz"` | This is the liveness check endpoint |
| livenessProbe.httpGet.port | string | `"http"` |  |

livenessProbe:
  httpGet:
    # -- This is the liveness check endpoint
    path: /healthz
    port: http

controller:
  publishService:
    # -- Whether to expose the ingress controller to the public world sdf
    enabled: false

# -- Number of nginx-ingress pods to load balance between sdf.
  # Do not set this below 2.
  replicas: 2
0707010000010A000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002D00000000helm-docs-1.11.1/example-charts/files-values0707010000010B000081A400000000000000000000000164C03CE4000001CD000000000000000000000000000000000000003800000000helm-docs-1.11.1/example-charts/files-values/Chart.yamlapiVersion: v2
name: best-values-example
description: One of the best values parsing example charts here, exhibits several more complicated examples
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/best-values-example"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/best-values-example"]
engine: gotpl
type: application
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
0707010000010C000081A400000000000000000000000164C03CE400000A71000000000000000000000000000000000000003700000000helm-docs-1.11.1/example-charts/files-values/README.md# best-values-example

One of the best values parsing example charts here, exhibits several more complicated examples

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

## Additional Information

## Installing the Chart

To install the chart with the release name `my-release`:

```console
$ helm repo add foo-bar http://charts.foo-bar.com
$ helm install my-release foo-bar/best-values-example
```

Some file contents:

```
some:
  data: "test"
```

Glob contents as config map:

```
apiVersion: v1
kind: ConfigMap
metadata:
  name: test
data:
  resource1.yaml: |-
      some:
        resource: "blah"
  resource2.yaml: |-
      some:
        resource: "blah2"
dataSecret:
  resource1.yaml: c29tZToKICByZXNvdXJjZTogImJsYWgi
  resource2.yaml: c29tZToKICByZXNvdXJjZTogImJsYWgyIg==
```

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| config.databasesToCreate[0] | string | `"postgresql"` | default database for storage of database metadata |
| config.databasesToCreate[1] | string | `"hashbash"` | database for the [hashbash](https://github.com/norwoodj/hashbash) project |
| config.usersToCreate[0] | object | `{"admin":true,"name":"root"}` | admin user |
| config.usersToCreate[1] | object | `{"name":"hashbash","readwriteDatabases":["hashbash"]}` | user with access to the database with the same name |
| statefulset.extraVolumes | list | `[{"emptyDir":{},"name":"data"}]` | Additional volumes to be mounted into the database container |
| statefulset.image.repository | string | `"jnorwood/postgresq"` | Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files |
| statefulset.image.tag | string | `"11"` |  |
| statefulset.livenessProbe | object | `{"enabled":false}` | Configure the healthcheck for the database |
| statefulset.podLabels | object | `{}` | The labels to be applied to instances of the database |

## Additional Information

## Installing the Chart

To install the chart with the release name `my-release`:

```console
$ helm repo add foo-bar http://charts.foo-bar.com
$ helm install my-release foo-bar/{{ template "chart.name" . }}
```

Some file contents:

```
{{ .Files.Get "somefile.yaml" }}
```

Glob contents as config map:

```
apiVersion: v1
kind: ConfigMap
metadata:
  name: test
data:
{{ (.Files.Glob "templates/**.yaml").AsConfig | indent 2 }}
dataSecret:
{{ (.Files.Glob "templates/**.yaml").AsSecrets | indent 2 }}
```

{{ template "helm-docs.versionFooter" . }}
0707010000010E000081A400000000000000000000000164C03CE400000014000000000000000000000000000000000000003B00000000helm-docs-1.11.1/example-charts/files-values/somefile.yamlsome:
  data: "test"0707010000010F000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003700000000helm-docs-1.11.1/example-charts/files-values/templates07070100000110000081A400000000000000000000000164C03CE400000018000000000000000000000000000000000000004600000000helm-docs-1.11.1/example-charts/files-values/templates/resource1.yamlsome:
  resource: "blah"07070100000111000081A400000000000000000000000164C03CE400000019000000000000000000000000000000000000004600000000helm-docs-1.11.1/example-charts/files-values/templates/resource2.yamlsome:
  resource: "blah2"07070100000112000081A400000000000000000000000164C03CE400000369000000000000000000000000000000000000003900000000helm-docs-1.11.1/example-charts/files-values/values.yamlstatefulset:
  image:
    # -- Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files
    repository: jnorwood/postgresq
    tag: "11"

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}
07070100000113000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002E00000000helm-docs-1.11.1/example-charts/full-template07070100000114000081A400000000000000000000000164C03CE400000218000000000000000000000000000000000000003900000000helm-docs-1.11.1/example-charts/full-template/Chart.yamlapiVersion: v2
name: full-template
deprecated: true
version: "1.0.0"
type: application
appVersion: "13.0.0"
description: A chart for showing every README-element
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template"
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template"]
kubeVersion: "<=1.18"
engine: gotpl

dependencies:
  - name: nginx-ingress
    version: "0.22.1"
    repository: "@stable"
07070100000115000081A400000000000000000000000164C03CE4000014C5000000000000000000000000000000000000003800000000helm-docs-1.11.1/example-charts/full-template/README.md# full-template

## `extra.flower`
```
          ,-.
 ,     ,-.   ,-.
/ \   (   )-(   )
\ |  ,.>-(   )-<
 \|,' (   )-(   )
  Y ___`-'   `-'
  |/__/   `-'
  |
  |
  |    -hi-
__|_____________
```

## `chart.deprecationWarning`
> **:exclamation: This Helm Chart is deprecated!**

## `chart.name`

full-template

## `chart.description`

A chart for showing every README-element

## `chart.version`

1.0.0

## `chart.versionBadge`

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square)

## `chart.type`

application

## `chart.typeBadge`

![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

## `chart.appVersion`

13.0.0

## `chart.appVersionBadge`

![AppVersion: 13.0.0](https://img.shields.io/badge/AppVersion-13.0.0-informational?style=flat-square)

## `chart.badgesSection`

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 13.0.0](https://img.shields.io/badge/AppVersion-13.0.0-informational?style=flat-square)

## `chart.homepage`

https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template

## `chart.homepageLine`

**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>

## `chart.maintainersHeader`

## Maintainers

## `chart.maintainersTable`

| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> |  |

## `chart.maintainersSection`

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> |  |

## `chart.sourcesHeader`

## Source Code

## `chart.sourcesList`

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>

## `chart.sourcesSection`

## Source Code

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>

## `chart.kubeVersion`

<=1.18

## `chart.kubeVersionLine`

Kubernetes: `<=1.18`

## `chart.requirementsHeader`

## Requirements

## `chart.requirementsTable`

| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |

## `chart.requirementsSection`

## Requirements

Kubernetes: `<=1.18`

| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |

## `chart.valuesHeader`

## Values

## `chart.valuesTable`

## `chart.valuesSection`

## Values

## `extra.flower`
{{ template "extra.flower" . }}

## `chart.deprecationWarning`
{{ template "chart.deprecationWarning" . }}

## `chart.name`

## `chart.description`

## `chart.version`

## `chart.versionBadge`

## `chart.type`

## `chart.typeBadge`

## `chart.appVersion`

## `chart.appVersionBadge`

## `chart.badgesSection`

## `chart.homepage`

## `chart.homepageLine`

## `chart.maintainersHeader`

## `chart.maintainersTable`

## `chart.maintainersSection`

## `chart.sourcesHeader`

## `chart.sourcesList`

## `chart.sourcesSection`

## `chart.kubeVersion`

## `chart.kubeVersionLine`

## `chart.requirementsHeader`

## `chart.requirementsTable`

## `chart.requirementsSection`

## `chart.valuesHeader`

## `chart.valuesTable`

## `chart.valuesSection`

{{ template "helm-docs.versionFooter" . }}
07070100000117000081A400000000000000000000000164C03CE4000004FD000000000000000000000000000000000000003A00000000helm-docs-1.11.1/example-charts/full-template/values.yamlcontroller:
  name: controller
  image:
    repository: nginx-ingress-controller
    tag: "18.0831"

# controller.persistentVolumeClaims -- List of persistent volume claims to create.
  # For very long comments, break them into multiple lines.
  # @default -- the chart will construct this list internally unless specified
  persistentVolumeClaims: []

extraVolumes:
    - name: config-volume
      configMap:
        # controller.extraVolumes[0].configMap.name -- Uses the name of the configmap created by this chart
        name: nginx-ingress-config

# controller.ingressClass -- Name of the ingress class to route through this controller
  ingressClass: nginx

# controller.podLabels -- The labels to be applied to instances of the controller pod
  podLabels: {}

publishService:
    # controller.publishService.enabled -- Whether to expose the ingress controller to the public world
    enabled: false

# controller.replicas -- (int) Number of nginx-ingress pods to load balance between
  replicas:

service:
    annotations:
      # controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" -- Hostname to be assigned to the ELB for the service
      external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com

type: LoadBalancer
07070100000118000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003100000000helm-docs-1.11.1/example-charts/fully-documented07070100000119000081A400000000000000000000000164C03CE40000020C000000000000000000000000000000000000003C00000000helm-docs-1.11.1/example-charts/fully-documented/Chart.yamlapiVersion: v2
name: nginx-ingress
description: A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"]
engine: gotpl
type: application
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
dependencies:
  - name: nginx-ingress
    version: "0.22.1"
    repository: "@stable"
0707010000011A000081A400000000000000000000000164C03CE400000543000000000000000000000000000000000000003B00000000helm-docs-1.11.1/example-charts/fully-documented/README.md# nginx-ingress

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions

**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> |  |

## Source Code

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller | object | `{"image":{"repository":"nginx-ingress-controller","tag":"18.0831"},"name":"controller"}` | The controller |
| controller.image | object | `{"repository":"nginx-ingress-controller","tag":"18.0831"}` | The image of the controller |
| controller.image.repository | string | `"nginx-ingress-controller"` | The repository of the controller |
| controller.image.tag | string | `"18.0831"` | The tag of the image of the controller |
| controller.name | string | `"controller"` | The name of the controller |

0707010000011B000081A400000000000000000000000164C03CE400000174000000000000000000000000000000000000003D00000000helm-docs-1.11.1/example-charts/fully-documented/values.yaml# controller -- The controller
controller:
  # controller.name -- The name of the controller
  name: controller
  # controller.image -- The image of the controller
  image:
    # controller.image.repository -- The repository of the controller
    repository: nginx-ingress-controller
    # controller.image.tag -- The tag of the image of the controller
    tag: "18.0831"
0707010000011C000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002E00000000helm-docs-1.11.1/example-charts/funky-version0707010000011D000081A400000000000000000000000164C03CE40000017D000000000000000000000000000000000000003900000000helm-docs-1.11.1/example-charts/funky-version/Chart.yamlapiVersion: v2
name: funky-version
description: A very simple chart with a funky version
version: "0.1.0-alpha-rc2"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version"]
engine: gotpl
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
0707010000011E000081A400000000000000000000000164C03CE400000288000000000000000000000000000000000000003800000000helm-docs-1.11.1/example-charts/funky-version/README.md# funky-version

![Version: 0.1.0-alpha-rc2](https://img.shields.io/badge/Version-0.1.0--alpha--rc2-informational?style=flat-square)

A very simple chart with a funky version

**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> |  |

## Source Code

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version>

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
0707010000011F000081A400000000000000000000000164C03CE400000000000000000000000000000000000000000000003A00000000helm-docs-1.11.1/example-charts/funky-version/values.yaml07070100000120000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002700000000helm-docs-1.11.1/example-charts/helm-307070100000121000081A400000000000000000000000164C03CE40000020C000000000000000000000000000000000000003200000000helm-docs-1.11.1/example-charts/helm-3/Chart.yamlapiVersion: v2
name: nginx-ingress
description: A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"]
engine: gotpl
type: application
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
dependencies:
  - name: nginx-ingress
    version: "0.22.1"
    repository: "@stable"
07070100000122000081A400000000000000000000000164C03CE400000920000000000000000000000000000000000000003100000000helm-docs-1.11.1/example-charts/helm-3/README.md# nginx-ingress

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions

**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> |  |

## Source Code

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes | list | `[{"configMap":{"name":"nginx-ingress-config"},"name":"config-volume"}]` | Additional volumes to be mounted into the ingress controller container |
| controller.image.repository | string | `"nginx-ingress-controller"` |  |
| controller.image.tag | string | `"18.0831"` |  |
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
| controller.livenessProbe | object | `{"httpGet":{"path":"/healthz","port":8080}}` | Configure the healthcheck for the ingress controller |
| controller.livenessProbe.httpGet.path | string | `"/healthz"` | This is the liveness check endpoint |
| controller.name | string | `"controller"` |  |
| controller.persistentVolumeClaims | list | `[]` | List of persistent volume claims to create |
| controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` |  |

# controller.persistentVolumeClaims -- List of persistent volume claims to create
  persistentVolumeClaims: []

# controller.extraVolumes -- Additional volumes to be mounted into the ingress controller container
  extraVolumes:
    - name: config-volume
      configMap:
        name: nginx-ingress-config

# controller.livenessProbe -- Configure the healthcheck for the ingress controller
  livenessProbe:
    httpGet:
      # controller.livenessProbe.httpGet.path -- This is the liveness check endpoint
      path: /healthz
      port: 8080

# controller.ingressClass -- Name of the ingress class to route through this controller
  ingressClass: nginx

# controller.podLabels -- The labels to be applied to instances of the controller pod
  podLabels: {}

publishService:
    # controller.publishService.enabled -- Whether to expose the ingress controller to the public world
    enabled: false

# controller.replicas -- (int) Number of nginx-ingress pods to load balance between
  replicas:

type: LoadBalancer
07070100000124000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002C00000000helm-docs-1.11.1/example-charts/ignored-one07070100000125000081A400000000000000000000000164C03CE4000001A0000000000000000000000000000000000000003700000000helm-docs-1.11.1/example-charts/ignored-one/Chart.yamlapiVersion: v1
name: ignored-one
description: A demonstration of the ability of a .helmdocsignore file to ignore files by Chart.yaml file
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-one"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-one"]
engine: gotpl
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
07070100000126000081A400000000000000000000000164C03CE400000003000000000000000000000000000000000000003800000000helm-docs-1.11.1/example-charts/ignored-one/values.yaml{}
07070100000127000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003700000000helm-docs-1.11.1/example-charts/ignored-values-example07070100000128000081A400000000000000000000000164C03CE400000192000000000000000000000000000000000000004200000000helm-docs-1.11.1/example-charts/ignored-values-example/Chart.yamlapiVersion: v2
name: ignored-values-example
description: Based on best-values-example
version: "0.1.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-values-example"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-values-example"]
engine: gotpl
type: application
maintainers:
  - email: jakub.buczak@gmail.com
    name: Jakub Buczak
07070100000129000081A400000000000000000000000164C03CE400000783000000000000000000000000000000000000004100000000helm-docs-1.11.1/example-charts/ignored-values-example/README.md# ignored-values-example

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

Based on best-values-example

**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-values-example>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Jakub Buczak | <jakub.buczak@gmail.com> |  |

## Source Code

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-values-example>

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| config.databasesToCreate[0] | string | `"postgresql"` | default database for storage of database metadata |
| config.databasesToCreate[1] | string | `"hashbash"` | database for the [hashbash](https://github.com/norwoodj/hashbash) project |
| config.usersToCreate[0] | object | `{"admin":true,"name":"root"}` | admin user |
| config.usersToCreate[1] | object | `{"name":"hashbash","readwriteDatabases":["hashbash"]}` | user with access to the database with the same name |
| configWithAllValuesIgnored | object | `{}` |  |
| statefulset.extraVolumes | list | `[{"emptyDir":{},"name":"data"}]` | Additional volumes to be mounted into the database container |
| statefulset.image.repository | string | `"jnorwood/postgresq"` | Image to use for deploying, must support an entrypoint which creates users/databases from appropriate config files |
| statefulset.image.tag | string | `"11"` |  |
| statefulset.livenessProbe | object | `{"enabled":false}` | Configure the healthcheck for the database |
| statefulset.podLabels | object | `{}` | The labels to be applied to instances of the database |

# -- Additional volumes to be mounted into the database container
  extraVolumes:
    - name: data
      emptyDir: {}

# -- Configure the healthcheck for the database
  livenessProbe:
    enabled: false

# -- The labels to be applied to instances of the database
  podLabels: {}

config:
  databasesToCreate:
    # -- default database for storage of database metadata
    - postgresql

# -- database for the [hashbash](https://github.com/norwoodj/hashbash) project
    - hashbash

usersToCreate:
    # -- admin user
    - {name: root, admin: true}

# -- user with access to the database with the same name
    - {name: hashbash, readwriteDatabases: [hashbash]}

# @ignore test
    - {name: test, readDatabases: [test]}

# @ignore
internalConfig:
  rpcPort: 8080
  # -- this should also be ignored
  generateData: true

# @ignore
ignoredConfig: 6

configWithAllValuesIgnored:
  # @ignore
  ignoredOne: true
  # @ignore
  ignoredTwo: "?"
0707010000012B000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002D00000000helm-docs-1.11.1/example-charts/ignored-zero0707010000012C000081A400000000000000000000000164C03CE4000001A3000000000000000000000000000000000000003800000000helm-docs-1.11.1/example-charts/ignored-zero/Chart.yamlapiVersion: v1
name: ignored-zero
description: A demonstration of the ability of a .helmdocsignore file to ignore charts by directory name
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-zero"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/ignored-zero"]
engine: gotpl
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
0707010000012D000081A400000000000000000000000164C03CE400000003000000000000000000000000000000000000003900000000helm-docs-1.11.1/example-charts/ignored-zero/values.yaml{}
0707010000012E000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002B00000000helm-docs-1.11.1/example-charts/most-empty0707010000012F000081A400000000000000000000000164C03CE400000087000000000000000000000000000000000000003600000000helm-docs-1.11.1/example-charts/most-empty/Chart.yamlapiVersion: v1
name: most-empty
version: "0.2.0"
engine: gotpl
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
07070100000130000081A400000000000000000000000164C03CE400000280000000000000000000000000000000000000003500000000helm-docs-1.11.1/example-charts/most-empty/README.md# most-empty

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)

This is a good example of all the fields that don't appear when they aren't set in chart metadata. `description`,
`requirements`, and `values` are all empty and don't appear here.

There is a flower though:
```
          ,-.
 ,     ,-.   ,-.
/ \   (   )-(   )
\ |  ,.>-(   )-<
 \|,' (   )-(   )
  Y ___`-'   `-'
  |/__/   `-'
  |
  |
  |    -hi-
__|_____________
```

This is a good example of all the fields that don't appear when they aren't set in chart metadata. `description`,
`requirements`, and `values` are all empty and don't appear here.

There is a flower though:
{{ template "extra.flower" . }}

{{ template "helm-docs.versionFooter" . }}
07070100000132000081A400000000000000000000000164C03CE400000000000000000000000000000000000000000000003700000000helm-docs-1.11.1/example-charts/most-empty/values.yaml07070100000133000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002E00000000helm-docs-1.11.1/example-charts/nginx-ingress07070100000134000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004000000000helm-docs-1.11.1/example-charts/nginx-ingress-but-auto-comments07070100000135000081A400000000000000000000000164C03CE4000001A4000000000000000000000000000000000000004B00000000helm-docs-1.11.1/example-charts/nginx-ingress-but-auto-comments/Chart.yamlapiVersion: v1
name: nginx-ingress
description: A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"]
engine: gotpl
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
07070100000136000081A400000000000000000000000164C03CE400000930000000000000000000000000000000000000004A00000000helm-docs-1.11.1/example-charts/nginx-ingress-but-auto-comments/README.md# nginx-ingress

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)

A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions

**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> |  |

## Source Code

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| controller.extraVolumes | list | `[{"configMap":{"name":"nginx-ingress-config"},"name":"config-volume"}]` | Additional volumes to be mounted into the ingress controller container |
| controller.image.repository | string | `"nginx-ingress-controller"` |  |
| controller.image.tag | string | `"18.0831"` |  |
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
| controller.livenessProbe | object | `{"httpGet":{"path":"/healthz","port":8080}}` | Configure the healthcheck for the ingress controller |
| controller.livenessProbe.httpGet.path | string | `"/healthz"` | This is the liveness check endpoint |
| controller.name | string | `"controller"` |  |
| controller.persistentVolumeClaims | list | `[]` | List of persistent volume claims to create |
| controller.podLabels | object | A number of chart-specific labels | The labels to be applied to instances of the controller pod. By default, a number of labels will automatically be applied |
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between. Do not set this below 2 |
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` |  |

# -- List of persistent volume claims to create
  persistentVolumeClaims: []

# -- Additional volumes to be mounted into the ingress controller container
  extraVolumes:
    - name: config-volume
      configMap:
        name: nginx-ingress-config

# -- Configure the healthcheck for the ingress controller
  livenessProbe:
    httpGet:
      # -- This is the liveness check endpoint
      path: /healthz
      port: 8080

# -- Name of the ingress class to route through this controller
  ingressClass: nginx

# -- The labels to be applied to instances of the controller pod.
  # By default, a number of labels will automatically be applied
  # @default -- A number of chart-specific labels
  podLabels: {}

publishService:
    # -- Whether to expose the ingress controller to the public world
    enabled: false

# -- (int) Number of nginx-ingress pods to load balance between.
  # Do not set this below 2
  replicas:

service:
    annotations:
      # -- Hostname to be assigned to the ELB for the service
      external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com

type: LoadBalancer
07070100000139000081A400000000000000000000000164C03CE4000001A4000000000000000000000000000000000000003900000000helm-docs-1.11.1/example-charts/nginx-ingress/Chart.yamlapiVersion: v1
name: nginx-ingress
description: A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress"]
engine: gotpl
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
0707010000013A000081A400000000000000000000000164C03CE4000008BC000000000000000000000000000000000000003800000000helm-docs-1.11.1/example-charts/nginx-ingress/README.md# nginx-ingress

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)

A simple wrapper around the stable/nginx-ingress chart that adds a few of our conventions

**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> |  |

## Source Code

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/nginx-ingress>

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| @stable | nginx-ingress | 0.22.1 |

## Values

# controller.persistentVolumeClaims -- List of persistent volume claims to create
  persistentVolumeClaims: []

# controller.extraVolumes -- Additional volumes to be mounted into the ingress controller container
  extraVolumes:
    - name: config-volume
      configMap:
        name: nginx-ingress-config

# controller.ingressClass -- Name of the ingress class to route through this controller
  ingressClass: nginx

# controller.podLabels -- The labels to be applied to instances of the controller pod
  podLabels: {}

publishService:
    # controller.publishService.enabled -- Whether to expose the ingress controller to the public world
    enabled: false

# controller.replicas -- (int) Number of nginx-ingress pods to load balance between
  replicas:

type: LoadBalancer
0707010000013D000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003000000000helm-docs-1.11.1/example-charts/no-requirements0707010000013E000081A400000000000000000000000164C03CE4000001A2000000000000000000000000000000000000003B00000000helm-docs-1.11.1/example-charts/no-requirements/Chart.yamlapiVersion: v1
name: no-requirements
description: A simple chart that installs, let's say PrometheusRules, that needs no sub-charts
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-requirements"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-requirements"]
engine: gotpl
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
0707010000013F000081A400000000000000000000000164C03CE40000052B000000000000000000000000000000000000003A00000000helm-docs-1.11.1/example-charts/no-requirements/README.md# no-requirements

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)

A simple chart that installs, let's say PrometheusRules, that needs no sub-charts

**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-requirements>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> |  |

## Source Code

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-requirements>

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| rules.latency.percentiles.99.duration | string | `"5m"` | Duration for which the 99th percentile must be above the threshold to alert |
| rules.latency.percentiles.99.threshold | float | `1.5` | Threshold in seconds for our 99th percentile latency above which the alert will fire |
| rules.statusCodes.codes.5xx.duration | string | `"5m"` | Duration for which the percent of 5xx responses must be above the threshold to alert |
| rules.statusCodes.codes.5xx.threshold | float | `1.5` | Threshold percentage of 5xx responses above which the alert will fire |

statusCodes:
    codes:
      5xx:
        # rules.statusCodes.codes.5xx.threshold -- Threshold percentage of 5xx responses above which the alert will fire
        threshold: 1.5
        # rules.statusCodes.codes.5xx.duration -- Duration for which the percent of 5xx responses must be above the threshold to alert
        duration: 5m
07070100000141000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002A00000000helm-docs-1.11.1/example-charts/no-values07070100000142000081A400000000000000000000000164C03CE400000186000000000000000000000000000000000000003500000000helm-docs-1.11.1/example-charts/no-values/Chart.yamlapiVersion: v1
name: no-values
description: A very simple chart that doesn't even need any values for customization
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values"]
engine: gotpl
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
07070100000143000081A400000000000000000000000164C03CE400000285000000000000000000000000000000000000003400000000helm-docs-1.11.1/example-charts/no-values/README.md# no-values

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)

A very simple chart that doesn't even need any values for customization

**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> |  |

## Source Code

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values>

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
07070100000144000081A400000000000000000000000164C03CE400000000000000000000000000000000000000000000003600000000helm-docs-1.11.1/example-charts/no-values/values.yaml07070100000145000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003300000000helm-docs-1.11.1/example-charts/special-characters07070100000146000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000004500000000helm-docs-1.11.1/example-charts/special-characters-but-auto-comments07070100000147000081A400000000000000000000000164C03CE4000001B0000000000000000000000000000000000000005000000000helm-docs-1.11.1/example-charts/special-characters-but-auto-comments/Chart.yamlapiVersion: v2
name: special-characters
description: A chart demonstrating handling of special characters in values files
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters"]
engine: gotpl
type: application
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
07070100000148000081A400000000000000000000000164C03CE4000005F2000000000000000000000000000000000000004F00000000helm-docs-1.11.1/example-charts/special-characters-but-auto-comments/README.md# special-characters

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A chart demonstrating handling of special characters in values files

**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> |  |

## Source Code

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters>

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| elasticsearch.clusterHealthCheckParams | string | `"wait_for_status=yellow&timeout=1s"` | The Elasticsearch cluster health status params that will be used by readinessProbe command |
| elasticsearch.clusterHealthCheckParamsDescription | string | `""` | Now let's put some special characters in the description: wait_for_status=yellow&timeout=1s |
| htmlSnippets.one | string | `"<html>\n  <head></head>\n  <body>\n    <h1>Is this right, I don't know html</h1>\n  </body>\n</html>\n"` |  |
| htmlSnippets.three | string | `"<html><head></head></html>"` | Another description |
| htmlSnippets.two | string | `""` | Let's put it in the description <html></html> |

# -- Now let's put some special characters in the description: wait_for_status=yellow&timeout=1s
  clusterHealthCheckParamsDescription: ""

htmlSnippets:
  one: |
    <html>
      <head></head>
      <body>
        <h1>Is this right, I don't know html</h1>
      </body>
    </html>

# nonsense comment before
  #
  # -- Let's put it in the description <html></html>
  two: ""

# -- Another description
  # @default -- `"<html><head></head></html>"`
  three: ""
0707010000014A000081A400000000000000000000000164C03CE4000001B0000000000000000000000000000000000000003E00000000helm-docs-1.11.1/example-charts/special-characters/Chart.yamlapiVersion: v2
name: special-characters
description: A chart demonstrating handling of special characters in values files
version: "0.2.0"
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters"
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters"]
engine: gotpl
type: application
maintainers:
  - email: norwood.john.m@gmail.com
    name: John Norwood
0707010000014B000081A400000000000000000000000164C03CE4000005F2000000000000000000000000000000000000003D00000000helm-docs-1.11.1/example-charts/special-characters/README.md# special-characters

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A chart demonstrating handling of special characters in values files

**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| John Norwood | <norwood.john.m@gmail.com> |  |

## Source Code

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/special-characters>

## Values

# unrelated comments
  # before
  #
  # elasticsearch.clusterHealthCheckParamsDescription -- Now let's put some special characters in the description: wait_for_status=yellow&timeout=1s
  clusterHealthCheckParamsDescription: ""

htmlSnippets:
  one: |
    <html>
      <head></head>
      <body>
        <h1>Is this right, I don't know html</h1>
      </body>
    </html>

# htmlSnippets.two -- Let's put it in the description <html></html>
  two: ""

# htmlSnippets.three -- Another description
  # @default -- `"<html><head></head></html>"`
  three: ""
0707010000014D000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002900000000helm-docs-1.11.1/example-charts/umbrella0707010000014E000081A400000000000000000000000164C03CE400000150000000000000000000000000000000000000003400000000helm-docs-1.11.1/example-charts/umbrella/Chart.yamlapiVersion: v2
name: umbrella
description: A chart demonstrating that values documentation from child charts are aggregated on the parent chart.
version: "0.1.0"
type: application
dependencies:
  - name: sub-a
    version: 0.1.0
  - name: sub-b
    version: 0.1.0
  - name: sub-c
    version: 0.1.0
  - name: library
    version: 0.1.0
0707010000014F000081A400000000000000000000000164C03CE40000047E000000000000000000000000000000000000003300000000helm-docs-1.11.1/example-charts/umbrella/README.md# umbrella

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A chart demonstrating that values documentation from child charts are aggregated on the parent chart.

## Requirements

| Repository | Name | Version |
|------------|------|---------|
|  | library | 0.1.0 |
|  | sub-a | 0.1.0 |
|  | sub-b | 0.1.0 |
|  | sub-c | 0.1.0 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| global | object | `{}` |  |
| global.myGlobalKey | string | `"my-global-value"` | A global key |
| global.myGlobalSubChartKey | string | `"my-global-sub-chart-value"` | A global key defined in a sub chart |
| myParentKey | string | `"my-parent-value"` | A parent key |
| sub-a.mySubKeyA | string | `"my-sub-value-a"` | Value for sub-chart A |
| sub-b.mySubKeyB | string | `"my-sub-value-b"` | Value for sub-chart B |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
07070100000150000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003000000000helm-docs-1.11.1/example-charts/umbrella/charts07070100000151000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003800000000helm-docs-1.11.1/example-charts/umbrella/charts/library07070100000152000081A400000000000000000000000164C03CE400000076000000000000000000000000000000000000004300000000helm-docs-1.11.1/example-charts/umbrella/charts/library/Chart.yamlapiVersion: v2
name: library
description: An example library sub-chart with no values.
version: "0.1.0"
type: library
07070100000153000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003600000000helm-docs-1.11.1/example-charts/umbrella/charts/sub-a07070100000154000081A400000000000000000000000164C03CE4000000AD000000000000000000000000000000000000004100000000helm-docs-1.11.1/example-charts/umbrella/charts/sub-a/Chart.yamlapiVersion: v2
name: sub-a
description: A sub-chart.
version: "0.1.0"
type: application
dependencies:
  - name: library
    version: 0.1.0
    repository: file://../library
07070100000155000081A400000000000000000000000164C03CE400000348000000000000000000000000000000000000004000000000helm-docs-1.11.1/example-charts/umbrella/charts/sub-a/README.md# sub-a

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A sub-chart.

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| file://../library | library | 0.1.0 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| global.myGlobalKey | string | `"my-global-value"` | A global key |
| global.myGlobalSubChartKey | string | `"my-global-sub-chart-value"` | A global key defined in a sub chart |
| mySubKeyA | string | `"my-sub-value-a"` | Value for sub-chart A |

# -- A global key defined in a sub chart
  myGlobalSubChartKey: my-global-sub-chart-value

# -- Value for sub-chart A
mySubKeyA: my-sub-value-a
07070100000157000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003600000000helm-docs-1.11.1/example-charts/umbrella/charts/sub-b07070100000158000081A400000000000000000000000164C03CE4000000AD000000000000000000000000000000000000004100000000helm-docs-1.11.1/example-charts/umbrella/charts/sub-b/Chart.yamlapiVersion: v2
name: sub-b
description: A sub-chart.
version: "0.1.0"
type: application
dependencies:
  - name: library
    version: 0.1.0
    repository: file://../library
07070100000159000081A400000000000000000000000164C03CE4000002DA000000000000000000000000000000000000004000000000helm-docs-1.11.1/example-charts/umbrella/charts/sub-b/README.md# sub-b

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A sub-chart.

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| file://../library | library | 0.1.0 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| global.myGlobalKey | string | `"my-global-value"` | A global key |
| mySubKeyB | string | `"my-sub-value-b"` | Value for sub-chart B |

# -- Value for sub-chart B
mySubKeyB: my-sub-value-b
0707010000015B000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000003600000000helm-docs-1.11.1/example-charts/umbrella/charts/sub-c0707010000015C000081A400000000000000000000000164C03CE4000000AD000000000000000000000000000000000000004100000000helm-docs-1.11.1/example-charts/umbrella/charts/sub-c/Chart.yamlapiVersion: v2
name: sub-c
description: A sub-chart.
version: "0.1.0"
type: application
dependencies:
  - name: library
    version: 0.1.0
    repository: file://../library
0707010000015D000081A400000000000000000000000164C03CE40000026F000000000000000000000000000000000000004000000000helm-docs-1.11.1/example-charts/umbrella/charts/sub-c/README.md# sub-c

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A sub-chart.

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| file://../library | library | 0.1.0 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| global | object | `{}` |  |

# -- A parent key
myParentKey: my-parent-value
07070100000160000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000001A00000000helm-docs-1.11.1/git-hook07070100000161000081ED00000000000000000000000164C03CE4000000E1000000000000000000000000000000000000002400000000helm-docs-1.11.1/git-hook/helm-docs#!/usr/bin/env bash

set -e

if ! command -v helm-docs > /dev/null 2>&1; then
    echo "Please install helm-docs to run the pre-commit hook! https://github.com/norwoodj/helm-docs#installation"
    exit 1
fi

helm-docs "${@}"
07070100000162000081A400000000000000000000000164C03CE40000019F000000000000000000000000000000000000001800000000helm-docs-1.11.1/go.modmodule github.com/norwoodj/helm-docs

go 1.14

require (
	github.com/Masterminds/sprig/v3 v3.2.2
	github.com/gobwas/glob v0.2.3
	github.com/sirupsen/logrus v1.2.0
	github.com/spf13/cobra v0.0.5
	github.com/spf13/viper v1.4.0
	github.com/stretchr/testify v1.5.1
	golang.org/x/sys v0.0.0-20220330033206-e17cdc41300f // indirect
	gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776
	k8s.io/helm v2.14.3+incompatible
)
07070100000163000081A400000000000000000000000164C03CE400004560000000000000000000000000000000000000001800000000helm-docs-1.11.1/go.sumcloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
github.com/Masterminds/goutils v1.1.1 h1:5nUrii3FMTL5diU80unEVvNevw1nH4+ZV4DSLVJLSYI=
github.com/Masterminds/goutils v1.1.1/go.mod h1:8cTjp+g8YejhMuvIA5y2vz3BpJxksy863GQaJW2MFNU=
github.com/Masterminds/semver/v3 v3.1.1 h1:hLg3sBzpNErnxhQtUy/mmLR2I9foDujNK030IGemrRc=
github.com/Masterminds/semver/v3 v3.1.1/go.mod h1:VPu/7SZ7ePZ3QOrcuXROw5FAcLl4a0cBrbBpGY/8hQs=
github.com/Masterminds/sprig/v3 v3.2.2 h1:17jRggJu518dr3QaafizSXOjKYp94wKfABxUmyxvxX8=
github.com/Masterminds/sprig/v3 v3.2.2/go.mod h1:UoaO7Yp8KlPnJIYWTFkMaqPUYKTfGFPhxNuwnnxkKlk=
github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU=
github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0=
github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=
github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc=
github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
github.com/coreos/bbolt v1.3.2/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk=
github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE=
github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8NzMklzPG4d5KIOhIy30Tk=
github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=
github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA=
github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954/go.mod h1:vAd38F8PWV+bWy6jNmig1y/TA+kYO4g3RSRF0IAv0no=
github.com/fsnotify/fsnotify v1.4.7 h1:IXs+QLmnXW2CcXuY+8Mzv/fWEsPGWxqefPtCP5CnV9I=
github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE=
github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk=
github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
github.com/gobwas/glob v0.2.3 h1:A4xDbljILXROh+kObIiy5kIaPYD8e96x1tgBhUI5J+Y=
github.com/gobwas/glob v0.2.3/go.mod h1:d3Ez4x06l9bZtSvzIay5+Yzi0fmZzPgnTbPcKjJAkT8=
github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ=
github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4=
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
github.com/golang/groupcache v0.0.0-20190129154638-5b532d6fd5ef/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=
github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ=
github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
github.com/google/uuid v1.1.1 h1:Gkbcsh/GbpXz7lPftLA3P6TYMwjCLYm83jiFQZF/3gY=
github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ=
github.com/grpc-ecosystem/go-grpc-middleware v1.0.0/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs=
github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0/go.mod h1:8NvIoxWQoOIhqOTXgfV/d3M/q6VIi02HzZEHgUlZvzk=
github.com/grpc-ecosystem/grpc-gateway v1.9.0/go.mod h1:vNeuVxBJEsws4ogUvrchl83t/GYV9WGTSLVdBhOQFDY=
github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=
github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
github.com/huandu/xstrings v1.3.1 h1:4jgBlKK6tLKFvO8u5pmYjG91cqytmDCDvGh7ECVFfFs=
github.com/huandu/xstrings v1.3.1/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE=
github.com/imdario/mergo v0.3.11 h1:3tnifQM4i+fbajXKBHXWEH+KvNHqojZ778UH75j3bGA=
github.com/imdario/mergo v0.3.11/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA=
github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo=
github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w=
github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q=
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
github.com/konsorten/go-windows-terminal-sequences v1.0.1 h1:mweAR1A6xJ3oS2pRaGiHgQ4OO8tzTaLawm8vnODuwDk=
github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc=
github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
github.com/magiconair/properties v1.8.0 h1:LLgXmsheXeRoUOBOjtwPQCWIYqM/LU1ayDtDePerRcY=
github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
github.com/mitchellh/copystructure v1.0.0 h1:Laisrj+bAB6b/yJwB5Bt3ITZhGJdqmxquMKeZ+mmkFQ=
github.com/mitchellh/copystructure v1.0.0/go.mod h1:SNtv71yrdKgLRyLFxmLdkAbkKEFWgYaq1OVrnRcwhnw=
github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE=
github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
github.com/mitchellh/reflectwalk v1.0.0 h1:9D+8oIskB4VJBN5SFlmc27fSlIBZaov1Wpk/IfikLNY=
github.com/mitchellh/reflectwalk v1.0.0/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw=
github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
github.com/pelletier/go-toml v1.2.0 h1:T5zMGML61Wp+FlcbWjRDT7yAxhJNAiPPLOFECq181zc=
github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw=
github.com/prometheus/client_golang v0.9.3/go.mod h1:/TN21ttK/J9q6uSwhBd54HahCDft0ttaMvbicHlPoso=
github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo=
github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
github.com/prometheus/common v0.0.0-20181113130724-41aa239b4cce/go.mod h1:daVV7qP5qjZbuso7PdcryaAu0sAZbrN9i7WWcTMWvro=
github.com/prometheus/common v0.4.0/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4=
github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk=
github.com/prometheus/procfs v0.0.0-20190507164030-5867b95ac084/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA=
github.com/prometheus/tsdb v0.7.1/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40TwIPHuXU=
github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg=
github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
github.com/shopspring/decimal v1.2.0 h1:abSATXmQEYyShuxI4/vyW3tV1MrKAJzCZ/0zLUXYbsQ=
github.com/shopspring/decimal v1.2.0/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o=
github.com/sirupsen/logrus v1.2.0 h1:juTguoYk5qI21pwyTXY3B3Y5cOTH3ZUyZCg1v/mihuo=
github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo=
github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM=
github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
github.com/spf13/afero v1.1.2 h1:m8/z1t7/fwjysjQRYbP0RD+bUIF/8tJwPdEZsI83ACI=
github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
github.com/spf13/cast v1.3.1 h1:nFm6S0SMdyzrzcmThSipiEubIDy8WEXKNZ0UOgiRpng=
github.com/spf13/cast v1.3.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
github.com/spf13/cobra v0.0.5 h1:f0B+LkLX6DtmRH1isoNA9VTtNUK9K8xYd28JNNfOv/s=
github.com/spf13/cobra v0.0.5/go.mod h1:3K3wKZymM7VvHMDS9+Akkh4K60UwM26emMESw8tLCHU=
github.com/spf13/jwalterweatherman v1.0.0 h1:XHEdyB+EcvlqZamSM4ZOMGlc93t6AcsBEu9Gc1vn7yk=
github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo=
github.com/spf13/pflag v1.0.3 h1:zPAT6CGy6wXeQ7NtTnaTerfKOsV6V6F8agHXFiazDkg=
github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
github.com/spf13/viper v1.3.2/go.mod h1:ZiWeW+zYFKm7srdB9IoDzzZXaJaI5eL9QjNiN/DMA2s=
github.com/spf13/viper v1.4.0 h1:yXHLWeravcrgGyFSyCgdYpXQ9dR9c/WED3pg1RhxqEU=
github.com/spf13/viper v1.4.0/go.mod h1:PTJ7Z/lr49W6bUbkmS1V3by4uWynFiR9p7+dSq/yZzE=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U=
github.com/ugorji/go v1.1.4/go.mod h1:uQMGLiO92mf5W77hV/PUCpI3pbzQx3CRekS0kk+RGrc=
github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0=
github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2/go.mod h1:UETIi67q53MR2AWcXfiuqkDkRtnGDLqkBTpCHuJHxtU=
github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q=
go.etcd.io/bbolt v1.3.2/go.mod h1:IbVyRI1SCnLcuJnV2u8VeU0CEYM7e686BmAb1XKL+uU=
go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE=
go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0=
go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q=
golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20200414173820-0848c9571904 h1:bXoxMPcSLOq08zI3/c5dEBT6lE4eh+jOh886GHrn6V8=
golang.org/x/crypto v0.0.0-20200414173820-0848c9571904/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20181220203305-927f97764cc3/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190522155817-f3200d17e092/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks=
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20181107165924-66b7b1311ac8/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20220330033206-e17cdc41300f h1:rlezHXNlxYWvBCzNses9Dlc7nGFaNMJeqLolcmQSSZY=
golang.org/x/sys v0.0.0-20220330033206-e17cdc41300f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/tools v0.0.0-20180221164845-07fd8470d635/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc=
google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c=
google.golang.org/grpc v1.21.0/go.mod h1:oYelfM1adQP15Ek0mdvEgi9Df8B9CZIaU1084ijfRaM=
gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo=
gopkg.in/yaml.v2 v2.0.0-20170812160011-eb3733d160e7/go.mod h1:JAlM8MvJe8wmxCU4Bli9HhUf9+ttbYbLASfIpnQbh74=
gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776 h1:tQIYjPdBoyREyB9XMu+nnTclpTYkz2zFM+lzLJFO4gQ=
gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
k8s.io/helm v2.14.3+incompatible h1:uzotTcZXa/b2SWVoUzM1xiCXVjI38TuxMujS/1s+3Gw=
k8s.io/helm v2.14.3+incompatible/go.mod h1:LZzlS4LQBHfciFOurYBFkCMTaZ0D1l+p0teMg7TSULI=
07070100000164000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000001500000000helm-docs-1.11.1/pkg07070100000165000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000001E00000000helm-docs-1.11.1/pkg/document07070100000166000081A400000000000000000000000164C03CE4000007D7000000000000000000000000000000000000003300000000helm-docs-1.11.1/pkg/document/dependency_values.gopackage document

import (
	"path/filepath"
	"strings"

log "github.com/sirupsen/logrus"
	"gopkg.in/yaml.v3"

"github.com/norwoodj/helm-docs/pkg/helm"
)

type DependencyValues struct {
	Prefix                  string
	ChartValues             *yaml.Node
	ChartValuesDescriptions map[string]helm.ChartValueDescription
}

func GetDependencyValues(root helm.ChartDocumentationInfo, allChartInfoByChartPath map[string]helm.ChartDocumentationInfo) ([]DependencyValues, error) {
	return getDependencyValuesWithPrefix(root, allChartInfoByChartPath, "")
}

func getDependencyValuesWithPrefix(root helm.ChartDocumentationInfo, allChartInfoByChartPath map[string]helm.ChartDocumentationInfo, prefix string) ([]DependencyValues, error) {
	if len(root.Dependencies) == 0 {
		return nil, nil
	}

result := make([]DependencyValues, 0, len(root.Dependencies))

for _, dep := range root.Dependencies {
		searchPath := ""

if strings.HasPrefix(dep.Repository, "file://") {
			searchPath = filepath.Join(root.ChartDirectory, strings.TrimPrefix(dep.Repository, "file://"))
		} else if dep.Repository != "" {
			log.Warnf("Chart in %q has a remote dependency %q. Dependency values will not be included.", root.ChartDirectory, dep.Name)
			continue
		} else {
			searchPath = filepath.Join(root.ChartDirectory, "charts", dep.Name)
		}

depInfo, ok := allChartInfoByChartPath[searchPath]
		if !ok {
			log.Warnf("Dependency with path %q was not found. Dependency values will not be included.", searchPath)
			continue
		}

alias := dep.Alias
		if alias == "" {
			alias = dep.Name
		}
		depPrefix := prefix + alias

result = append(result, DependencyValues{
			Prefix:                  depPrefix,
			ChartValues:             depInfo.ChartValues,
			ChartValuesDescriptions: depInfo.ChartValuesDescriptions,
		})

children, err := getDependencyValuesWithPrefix(depInfo, allChartInfoByChartPath, depPrefix+".")
		if err != nil {
			return nil, err
		}

result = append(result, children...)
	}

return result, nil
}
07070100000167000081A400000000000000000000000164C03CE400000D9B000000000000000000000000000000000000003800000000helm-docs-1.11.1/pkg/document/dependency_values_test.gopackage document_test

import (
	"path/filepath"
	"testing"

"github.com/norwoodj/helm-docs/pkg/helm"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"gopkg.in/yaml.v3"

. "github.com/norwoodj/helm-docs/pkg/document"
)

func TestGetDependencyValues(t *testing.T) {
	type args struct {
		root helm.ChartDocumentationInfo
		all  []helm.ChartDocumentationInfo
	}
	tests := []struct {
		name    string
		args    args
		want    []DependencyValues
		wantErr bool
	}{
		{
			name: "zero dependencies",
		},
		{
			name: "local dependency with name",
			args: args{
				root: info([]helm.ChartRequirementsItem{{Name: "sub-name"}}, "root"),
				all: []helm.ChartDocumentationInfo{
					info(nil, "root", "charts", "sub-name"),
				},
			},
			want: []DependencyValues{
				values("sub-name", "root", "charts", "sub-name"),
			},
		},
		{
			name: "local dependency with alias",
			args: args{
				root: info([]helm.ChartRequirementsItem{{Name: "sub-name", Alias: "sub-alias"}}, "root"),
				all: []helm.ChartDocumentationInfo{
					info(nil, "root", "charts", "sub-name"),
				},
			},
			want: []DependencyValues{
				values("sub-alias", "root", "charts", "sub-name"),
			},
		},
		{
			name: "nested dependencies",
			args: args{
				root: info([]helm.ChartRequirementsItem{{Name: "mid-a"}, {Name: "mid-b"}}, "root"),
				all: []helm.ChartDocumentationInfo{
					info([]helm.ChartRequirementsItem{{Name: "leaf-c"}, {Name: "leaf-d"}}, "root", "charts", "mid-a"),
					info([]helm.ChartRequirementsItem{{Name: "leaf-e"}, {Name: "leaf-f"}}, "root", "charts", "mid-b"),
					info(nil, "root", "charts", "mid-a", "charts", "leaf-c"),
					info(nil, "root", "charts", "mid-a", "charts", "leaf-d"),
					info(nil, "root", "charts", "mid-b", "charts", "leaf-e"),
					info(nil, "root", "charts", "mid-b", "charts", "leaf-f"),
				},
			},
			want: []DependencyValues{
				values("mid-a", "root", "charts", "mid-a"),
				values("mid-b", "root", "charts", "mid-b"),
				values("mid-a.leaf-c", "root", "charts", "mid-a", "charts", "leaf-c"),
				values("mid-a.leaf-d", "root", "charts", "mid-a", "charts", "leaf-d"),
				values("mid-b.leaf-e", "root", "charts", "mid-b", "charts", "leaf-e"),
				values("mid-b.leaf-f", "root", "charts", "mid-b", "charts", "leaf-f"),
			},
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			infosByChartPath := make(map[string]helm.ChartDocumentationInfo)
			for _, info := range tt.args.all {
				infosByChartPath[info.ChartDirectory] = info
			}
			got, err := GetDependencyValues(tt.args.root, infosByChartPath)
			if tt.wantErr {
				require.Error(t, err)
			} else {
				require.NoError(t, err)
			}
			assert.ElementsMatch(t, tt.want, got)
		})
	}
}

func info(dependencies []helm.ChartRequirementsItem, dirParts ...string) helm.ChartDocumentationInfo {
	dir := filepath.Join(dirParts...)
	return helm.ChartDocumentationInfo{
		ChartDirectory:          dir,
		ChartValues:             &yaml.Node{Value: dir},
		ChartValuesDescriptions: map[string]helm.ChartValueDescription{"value": {Description: dir}},
		ChartRequirements: helm.ChartRequirements{
			Dependencies: dependencies,
		},
	}
}

func values(prefix string, dirParts ...string) DependencyValues {
	dir := filepath.Join(dirParts...)
	return DependencyValues{
		Prefix:                  prefix,
		ChartValues:             &yaml.Node{Value: dir},
		ChartValuesDescriptions: map[string]helm.ChartValueDescription{"value": {Description: dir}},
	}
}
07070100000168000081A400000000000000000000000164C03CE400000A1A000000000000000000000000000000000000002700000000helm-docs-1.11.1/pkg/document/files.gopackage document

import (
	"encoding/base64"
	"io/ioutil"
	"os"
	"path"
	"path/filepath"
	"strings"

"github.com/gobwas/glob"
	log "github.com/sirupsen/logrus"
	"gopkg.in/yaml.v3"
)

type files struct {
	baseDir    string
	foundFiles map[string]*fileEntry
}

type fileEntry struct {
	Path string
	data []byte
}

func getFiles(dir string) (files, error) {
	result := files{
		baseDir:    dir,
		foundFiles: make(map[string]*fileEntry),
	}

err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
		if err != nil {
			return err
		}

if info.IsDir() {
			return nil
		}

result.foundFiles[path] = &fileEntry{Path: path}
		return nil
	})

if err != nil {
		return files{}, err
	}

return result, nil
}

func (f *fileEntry) GetData() []byte {
	if f.data == nil {
		data, err := ioutil.ReadFile(f.Path)
		if err != nil {
			log.Warnf("Error reading file contents for %s: %s", f.Path, err.Error())
			return []byte{}
		}
		f.data = data
	}

return f.data
}

func (f files) GetBytes(name string) []byte {
	if v, ok := f.foundFiles[filepath.Join(f.baseDir, name)]; ok {
		return v.GetData()
	}
	return []byte{}
}

func (f files) Get(name string) string {
	return string(f.GetBytes(name))
}

func (f files) Glob(pattern string) files {
	result := files{
		baseDir:    f.baseDir,
		foundFiles: make(map[string]*fileEntry),
	}
	g, err := glob.Compile(filepath.Join(f.baseDir, pattern), filepath.Separator)
	if err != nil {
		log.Warnf("Error compiling Glob patten %s: %s", pattern, err.Error())
		return result
	}

for filePath, entry := range f.foundFiles {
		if g.Match(filePath) {
			result.foundFiles[filePath] = entry
		}
	}

return result
}

func (f files) AsConfig() string {
	if len(f.foundFiles) == 0 {
		return ""
	}

m := make(map[string]string)

// Explicitly convert to strings, and file names
	for k, v := range f.foundFiles {
		m[path.Base(k)] = string(v.GetData())
	}

return toYAML(m)
}

func (f files) AsSecrets() string {
	if len(f.foundFiles) == 0 {
		return ""
	}

m := make(map[string]string)

for k, v := range f.foundFiles {
		m[path.Base(k)] = base64.StdEncoding.EncodeToString(v.GetData())
	}

return toYAML(m)
}

func (f files) Lines(path string) []string {
	if len(f.foundFiles) == 0 {
		return []string{}
	}
	entry, exists := f.foundFiles[path]
	if !exists {
		return []string{}
	}

return strings.Split(string(entry.GetData()), "\n")
}

func toYAML(v interface{}) string {
	data, err := yaml.Marshal(v)
	if err != nil {
		// Swallow errors inside a template.
		return ""
	}
	return strings.TrimSuffix(string(data), "\n")
}
07070100000169000081A400000000000000000000000164C03CE400000BCB000000000000000000000000000000000000002C00000000helm-docs-1.11.1/pkg/document/files_test.gopackage document

import (
	"github.com/stretchr/testify/assert"
	"os"
	"path"
	"testing"
)

// As the interface has been kept the same as in Helm, the tests also work here.
// Tests similar to https://github.com/helm/helm/blob/main/pkg/engine/files_test.go.

var cases = []struct {
	path, data string
}{
	{"ship/captain.txt", "The Captain"},
	{"ship/stowaway.txt", "Legatt"},
	{"story/name.txt", "The Secret Sharer"},
	{"story/author.txt", "Joseph Conrad"},
	{"multiline/test.txt", "bar\nfoo"},
}

func getTestFiles() files {
	a := files{
		baseDir:    "",
		foundFiles: make(map[string]*fileEntry),
	}
	for _, c := range cases {
		a.foundFiles[c.path] = &fileEntry{
			Path: c.path,
			data: []byte(c.data),
		}
	}

return a
}

func TestNewFiles(t *testing.T) {
	files := getTestFiles()

if len(files.foundFiles) != len(cases) {
		t.Errorf("Expected len() = %d, got %d", len(cases), len(files.foundFiles))
	}

for i, f := range cases {
		if got := string(files.GetBytes(f.path)); got != f.data {
			t.Errorf("%d: expected %q, got %q", i, f.data, got)
		}
		if got := files.Get(f.path); got != f.data {
			t.Errorf("%d: expected %q, got %q", i, f.data, got)
		}
	}
}

func TestFileGlob(t *testing.T) {
	as := assert.New(t)

f := getTestFiles()

matched := f.Glob("story/**")

as.Len(matched.foundFiles, 2, "Should be two files in glob story/**")
	as.Equal("Joseph Conrad", matched.Get("story/author.txt"))
}

func TestToConfig(t *testing.T) {
	as := assert.New(t)

f := getTestFiles()
	out := f.Glob("**/captain.txt").AsConfig()
	as.Equal("captain.txt: The Captain", out)

out = f.Glob("ship/**").AsConfig()
	as.Equal("captain.txt: The Captain\nstowaway.txt: Legatt", out)
}

func TestToSecret(t *testing.T) {
	as := assert.New(t)

f := getTestFiles()

out := f.Glob("ship/**").AsSecrets()
	as.Equal("captain.txt: VGhlIENhcHRhaW4=\nstowaway.txt: TGVnYXR0", out)
}

func TestLines(t *testing.T) {
	as := assert.New(t)

f := getTestFiles()

out := f.Lines("multiline/test.txt")
	as.Len(out, 2)

as.Equal("bar", out[0])
}

func TestGetFiles(t *testing.T) {
	chartDir, err := os.MkdirTemp("", "*-helm-docs-chart")
	if err != nil {
		t.Fatal(err)
	}

t.Cleanup(func() {
		_ = os.RemoveAll(chartDir)
	})

testFiles := getTestFiles()
	for filePath, entry := range testFiles.foundFiles {
		fullPath := path.Join(chartDir, filePath)
		baseDir := path.Dir(fullPath)
		if err = os.MkdirAll(baseDir, 0o755); err != nil {
			t.Fatal(err)
		}
		data := entry.GetData()

if err = os.WriteFile(fullPath, data, 0o644); err != nil {
			t.Fatal(err)
		}
	}

chartFiles, err := getFiles(chartDir)
	if err != nil {
		t.Fatal(err)
	}

if len(chartFiles.foundFiles) != len(testFiles.foundFiles) {
		t.Errorf("chart files: expected %d, got %d", len(chartFiles.foundFiles), len(testFiles.foundFiles))
	}

// Sanity check the files have been read
	for filePath, entry := range chartFiles.foundFiles {
		data := entry.GetData()

if len(data) == 0 {
			t.Errorf("%s: expected file contents, got 0 bytes", filePath)
		}
	}
}
0707010000016A000081A400000000000000000000000164C03CE400000991000000000000000000000000000000000000002A00000000helm-docs-1.11.1/pkg/document/generate.gopackage document

import (
	"bytes"
	"os"
	"path/filepath"
	"regexp"
	"strings"

"github.com/norwoodj/helm-docs/pkg/helm"
	log "github.com/sirupsen/logrus"
	"github.com/spf13/viper"
)

func getOutputFile(chartDirectory string, dryRun bool) (*os.File, error) {
	if dryRun {
		return os.Stdout, nil
	}

outputFile := viper.GetString("output-file")
	f, err := os.Create(filepath.Join(chartDirectory, outputFile))

if err != nil {
		return nil, err
	}

return f, err
}

func PrintDocumentation(chartDocumentationInfo helm.ChartDocumentationInfo, chartSearchRoot string, templateFiles []string, dryRun bool, helmDocsVersion string, badgeStyle string, dependencyValues []DependencyValues) {
	log.Infof("Generating README Documentation for chart %s", chartDocumentationInfo.ChartDirectory)

chartDocumentationTemplate, err := newChartDocumentationTemplate(
		chartDocumentationInfo,
		chartSearchRoot,
		templateFiles,
		badgeStyle,
	)

if err != nil {
		log.Warnf("Error generating gotemplates for chart %s: %s", chartDocumentationInfo.ChartDirectory, err)
		return
	}

chartTemplateDataObject, err := getChartTemplateData(chartDocumentationInfo, helmDocsVersion, dependencyValues)
	if err != nil {
		log.Warnf("Error generating template data for chart %s: %s", chartDocumentationInfo.ChartDirectory, err)
		return
	}

outputFile, err := getOutputFile(chartDocumentationInfo.ChartDirectory, dryRun)
	if err != nil {
		log.Warnf("Could not open chart README file %s, skipping chart", filepath.Join(chartDocumentationInfo.ChartDirectory, "README.md"))
		return
	}

if !dryRun {
		defer outputFile.Close()
	}

var output bytes.Buffer
	err = chartDocumentationTemplate.Execute(&output, chartTemplateDataObject)
	if err != nil {
		log.Warnf("Error generating documentation for chart %s: %s", chartDocumentationInfo.ChartDirectory, err)
	}

output = applyMarkDownFormat(output)
	_, err = output.WriteTo(outputFile)
	if err != nil {
		log.Warnf("Error generating documentation file for chart %s: %s", chartDocumentationInfo.ChartDirectory, err)
	}
}

func applyMarkDownFormat(output bytes.Buffer) bytes.Buffer {
	outputString := output.String()
	re := regexp.MustCompile(` \n`)
	outputString = re.ReplaceAllString(outputString, "\n")

re = regexp.MustCompile(`\n{3,}`)
	outputString = re.ReplaceAllString(outputString, "\n\n")
	outputString = strings.TrimSuffix(outputString, "\n")

output.Reset()
	output.WriteString(outputString)
	return output
}
0707010000016B000081A400000000000000000000000164C03CE400001184000000000000000000000000000000000000002700000000helm-docs-1.11.1/pkg/document/model.gopackage document

import (
	"fmt"
	"sort"
	"strings"

log "github.com/sirupsen/logrus"
	"github.com/spf13/viper"
	"gopkg.in/yaml.v3"

"github.com/norwoodj/helm-docs/pkg/helm"
)

type valueRow struct {
	Key             string
	Type            string
	NotationType    string
	AutoDefault     string
	Default         string
	AutoDescription string
	Description     string
	Column          int
	LineNumber      int
	Dependency      string
	IsGlobal        bool
}

type chartTemplateData struct {
	helm.ChartDocumentationInfo
	HelmDocsVersion string
	Values          []valueRow
	Files           files
}

func sortValueRows(valueRows []valueRow) {
	sortOrder := viper.GetString("sort-values-order")

if sortOrder != FileSortOrder && sortOrder != AlphaNumSortOrder {
		log.Warnf("Invalid sort order provided %s, defaulting to %s", sortOrder, AlphaNumSortOrder)
		sortOrder = AlphaNumSortOrder
	}

sort.Slice(valueRows, func(i, j int) bool {
		// Globals sort above non-globals.
		if valueRows[i].IsGlobal != valueRows[j].IsGlobal {
			return valueRows[i].IsGlobal
		}

// Group by dependency for non-globals.
		if !valueRows[i].IsGlobal && !valueRows[j].IsGlobal {
			// Values for the main chart sort above values for dependencies.
			if (valueRows[i].Dependency == "") != (valueRows[j].Dependency == "") {
				return valueRows[i].Dependency == ""
			}

// Group dependency values together.
			if valueRows[i].Dependency != valueRows[j].Dependency {
				return valueRows[i].Dependency < valueRows[j].Dependency
			}
		}

// Sort the remaining values within the same section using the configured sort order.
		switch sortOrder {
		case FileSortOrder:
			if valueRows[i].LineNumber == valueRows[j].LineNumber {
				return valueRows[i].Column < valueRows[j].Column
			}
			return valueRows[i].LineNumber < valueRows[j].LineNumber
		case AlphaNumSortOrder:
			return valueRows[i].Key < valueRows[j].Key
		default:
			panic("cannot get here")
		}
	})
}

func getUnsortedValueRows(document *yaml.Node, descriptions map[string]helm.ChartValueDescription) ([]valueRow, error) {
	// Handle empty values file case.
	if document.Kind == 0 {
		return nil, nil
	}

if document.Kind != yaml.DocumentNode {
		return nil, fmt.Errorf("invalid node kind supplied: %d", document.Kind)
	}

if document.Content[0].Kind != yaml.MappingNode {
		return nil, fmt.Errorf("values file must resolve to a map (was %d)", document.Content[0].Kind)
	}

return createValueRowsFromField("", nil, document.Content[0], descriptions, true)
}

func getChartTemplateData(info helm.ChartDocumentationInfo, helmDocsVersion string, dependencyValues []DependencyValues) (chartTemplateData, error) {
	valuesTableRows, err := getUnsortedValueRows(info.ChartValues, info.ChartValuesDescriptions)
	if err != nil {
		return chartTemplateData{}, err
	}

if viper.GetBool("ignore-non-descriptions") {
		valuesTableRows = removeRowsWithoutDescription(valuesTableRows)
	}

if len(dependencyValues) > 0 {
		seenGlobalKeys := make(map[string]bool)
		for i, row := range valuesTableRows {
			if strings.HasPrefix(row.Key, "global.") {
				valuesTableRows[i].IsGlobal = true
				seenGlobalKeys[row.Key] = true
			}
		}

for _, dep := range dependencyValues {
			depValuesTableRows, err := getUnsortedValueRows(dep.ChartValues, dep.ChartValuesDescriptions)
			if err != nil {
				return chartTemplateData{}, err
			}

for _, row := range depValuesTableRows {
				if row.Key == "global" || strings.HasPrefix(row.Key, "global.") {
					if seenGlobalKeys[row.Key] {
						continue
					}
					row.IsGlobal = true
					seenGlobalKeys[row.Key] = true
				} else {
					row.Key = dep.Prefix + "." + row.Key
				}

row.Dependency = dep.Prefix
				valuesTableRows = append(valuesTableRows, row)
			}
		}
	}

sortValueRows(valuesTableRows)

files, err := getFiles(info.ChartDirectory)
	if err != nil {
		return chartTemplateData{}, err
	}

return chartTemplateData{
		ChartDocumentationInfo: info,
		HelmDocsVersion:        helmDocsVersion,
		Values:                 valuesTableRows,
		Files:                  files,
	}, nil
}

func removeRowsWithoutDescription(valuesTableRows []valueRow) []valueRow {

var valuesTableRowsWithoutDescription []valueRow
	for i := range valuesTableRows {
		if valuesTableRows[i].AutoDescription != "" || valuesTableRows[i].Description != "" {
			valuesTableRowsWithoutDescription = append(valuesTableRowsWithoutDescription, valuesTableRows[i])
		}
	}
	return valuesTableRowsWithoutDescription
}
0707010000016C000081A400000000000000000000000164C03CE40000389A000000000000000000000000000000000000002A00000000helm-docs-1.11.1/pkg/document/template.gopackage document

import (
	"fmt"
	"io/ioutil"
	"os"
	"path/filepath"
	"strings"
	"text/template"

"github.com/norwoodj/helm-docs/pkg/util"

"github.com/Masterminds/sprig/v3"
	log "github.com/sirupsen/logrus"

"github.com/norwoodj/helm-docs/pkg/helm"
)

const defaultDocumentationTemplate = `{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}

{{ template "helm-docs.versionFooter" . }}
`

func getNameTemplate() string {
	nameBuilder := strings.Builder{}
	nameBuilder.WriteString(`{{ define "chart.name" }}`)
	nameBuilder.WriteString("{{ .Name }}")
	nameBuilder.WriteString("{{ end }}")

return nameBuilder.String()
}

func getHeaderTemplate() string {
	headerTemplateBuilder := strings.Builder{}
	headerTemplateBuilder.WriteString(`{{ define "chart.header" }}`)
	headerTemplateBuilder.WriteString("# {{ .Name }}\n")
	headerTemplateBuilder.WriteString("{{ end }}")

return headerTemplateBuilder.String()
}

func getDeprecatedTemplate() string {
	deprecatedTemplateBuilder := strings.Builder{}
	deprecatedTemplateBuilder.WriteString(`{{ define "chart.deprecationWarning" }}`)
	deprecatedTemplateBuilder.WriteString("{{ if .Deprecated }}> **:exclamation: This Helm Chart is deprecated!**{{ end }}")
	deprecatedTemplateBuilder.WriteString("{{ end }}")

return deprecatedTemplateBuilder.String()
}

func getVersionTemplates(badgeStyle string) string {
	versionBuilder := strings.Builder{}
	versionBuilder.WriteString(`{{ define "chart.version" }}{{ .Version }}{{ end }}\n`)
	versionBuilder.WriteString(`{{ define "chart.versionBadge" }}`)
	versionBuilder.WriteString(fmt.Sprintf(`![Version: {{ .Version }}](https://img.shields.io/badge/Version-{{ .Version | replace "-" "--" }}-informational?style=%s) `, badgeStyle))
	versionBuilder.WriteString("{{ end }}")

return versionBuilder.String()
}

func getTypeTemplate(badgeStyle string) string {
	typeBuilder := strings.Builder{}
	typeBuilder.WriteString(`{{ define "chart.type" }}{{ .Type }}{{ end }}\n`)
	typeBuilder.WriteString(`{{ define "chart.typeBadge" }}`)
	typeBuilder.WriteString(fmt.Sprintf("{{ if .Type }}![Type: {{ .Type }}](https://img.shields.io/badge/Type-{{ .Type }}-informational?style=%s) {{ end }}", badgeStyle))
	typeBuilder.WriteString("{{ end }}")

return typeBuilder.String()
}

func getAppVersionTemplate(badgeStyle string) string {
	appVersionBuilder := strings.Builder{}
	appVersionBuilder.WriteString(`{{ define "chart.appVersion" }}{{ .AppVersion }}{{ end }}\n`)
	appVersionBuilder.WriteString(`{{ define "chart.appVersionBadge" }}`)
	appVersionBuilder.WriteString(fmt.Sprintf(`{{ if .AppVersion }}![AppVersion: {{ .AppVersion }}](https://img.shields.io/badge/AppVersion-{{ .AppVersion | replace "-" "--" }}-informational?style=%s) {{ end }}`, badgeStyle))
	appVersionBuilder.WriteString("{{ end }}")

return appVersionBuilder.String()
}

func getBadgesTemplates() string {
	badgeBuilder := strings.Builder{}
	badgeBuilder.WriteString(`{{ define "chart.badgesSection" }}`)
	badgeBuilder.WriteString(`{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}`)
	badgeBuilder.WriteString("{{ end }}")

return badgeBuilder.String()
}

func getDescriptionTemplate() string {
	descriptionBuilder := strings.Builder{}
	descriptionBuilder.WriteString(`{{ define "chart.description" }}`)
	descriptionBuilder.WriteString("{{ if .Description }}{{ .Description }}{{ end }}")
	descriptionBuilder.WriteString("{{ end }}")

return descriptionBuilder.String()
}

func getHomepageTemplate() string {
	homepageBuilder := strings.Builder{}
	homepageBuilder.WriteString(`{{ define "chart.homepage" }}{{ .Home }}{{ end }}\n`)
	homepageBuilder.WriteString(`{{ define "chart.homepageLine" }}`)
	homepageBuilder.WriteString("{{ if .Home }}**Homepage:** <{{ .Home }}>{{ end }}")
	homepageBuilder.WriteString("{{ end }}")

return homepageBuilder.String()
}

func getMaintainersTemplate() string {
	maintainerBuilder := strings.Builder{}
	maintainerBuilder.WriteString(`{{ define "chart.maintainersHeader" }}## Maintainers{{ end }}`)

maintainerBuilder.WriteString(`{{ define "chart.maintainersTable" }}`)
	maintainerBuilder.WriteString("| Name | Email | Url |\n")
	maintainerBuilder.WriteString("| ---- | ------ | --- |\n")
	maintainerBuilder.WriteString("  {{- range .Maintainers }}")
	maintainerBuilder.WriteString("\n| {{ .Name }} | {{ if .Email }}<{{ .Email }}>{{ end }} | {{ if .Url }}<{{ .Url }}>{{ end }} |")
	maintainerBuilder.WriteString("  {{- end }}")
	maintainerBuilder.WriteString("{{ end }}")

maintainerBuilder.WriteString(`{{ define "chart.maintainersSection" }}`)
	maintainerBuilder.WriteString("{{ if .Maintainers }}")
	maintainerBuilder.WriteString(`{{ template "chart.maintainersHeader" . }}`)
	maintainerBuilder.WriteString("\n\n")
	maintainerBuilder.WriteString(`{{ template "chart.maintainersTable" . }}`)
	maintainerBuilder.WriteString("{{ end }}")
	maintainerBuilder.WriteString("{{ end }}")

return maintainerBuilder.String()
}

func getSourceLinkTemplates() string {
	sourceLinkBuilder := strings.Builder{}
	sourceLinkBuilder.WriteString(`{{ define "chart.sourcesHeader" }}## Source Code{{ end}}`)

sourceLinkBuilder.WriteString(`{{ define "chart.sourcesList" }}`)
	sourceLinkBuilder.WriteString("{{- range .Sources }}")
	sourceLinkBuilder.WriteString("\n* <{{ . }}>")
	sourceLinkBuilder.WriteString("{{- end }}")
	sourceLinkBuilder.WriteString("{{ end }}")

sourceLinkBuilder.WriteString(`{{ define "chart.sourcesSection" }}`)
	sourceLinkBuilder.WriteString("{{ if .Sources }}")
	sourceLinkBuilder.WriteString(`{{ template "chart.sourcesHeader" . }}`)
	sourceLinkBuilder.WriteString("\n")
	sourceLinkBuilder.WriteString(`{{ template "chart.sourcesList" . }}`)
	sourceLinkBuilder.WriteString("{{ end }}")
	sourceLinkBuilder.WriteString("{{ end }}")

return sourceLinkBuilder.String()
}

func getRequirementsTableTemplates() string {
	requirementsSectionBuilder := strings.Builder{}
	requirementsSectionBuilder.WriteString(`{{ define "chart.requirementsHeader" }}## Requirements{{ end }}`)

requirementsSectionBuilder.WriteString(`{{ define "chart.kubeVersion" }}{{ .KubeVersion }}{{ end }}\n`)
	requirementsSectionBuilder.WriteString(`{{ define "chart.kubeVersionLine" }}`)
	requirementsSectionBuilder.WriteString("{{ if .KubeVersion }}Kubernetes: `{{ .KubeVersion }}`{{ end }}")
	requirementsSectionBuilder.WriteString("{{ end }}")

requirementsSectionBuilder.WriteString(`{{ define "chart.requirementsTable" }}`)
	requirementsSectionBuilder.WriteString("| Repository | Name | Version |\n")
	requirementsSectionBuilder.WriteString("|------------|------|---------|")
	requirementsSectionBuilder.WriteString("  {{- range .Dependencies }}")
	requirementsSectionBuilder.WriteString("    {{- if .Alias }}")
	requirementsSectionBuilder.WriteString("\n| {{ .Repository }} | {{ .Alias }}({{ .Name }}) | {{ .Version }} |")
	requirementsSectionBuilder.WriteString("    {{- else }}")
	requirementsSectionBuilder.WriteString("\n| {{ .Repository }} | {{ .Name }} | {{ .Version }} |")
	requirementsSectionBuilder.WriteString("    {{- end }}")
	requirementsSectionBuilder.WriteString("  {{- end }}")
	requirementsSectionBuilder.WriteString("{{ end }}")

requirementsSectionBuilder.WriteString(`{{ define "chart.requirementsSection" }}`)
	requirementsSectionBuilder.WriteString("{{ if or .Dependencies .KubeVersion }}")
	requirementsSectionBuilder.WriteString(`{{ template "chart.requirementsHeader" . }}`)
	requirementsSectionBuilder.WriteString("\n\n")
	requirementsSectionBuilder.WriteString("{{ if .KubeVersion }}")
	requirementsSectionBuilder.WriteString(`{{ template "chart.kubeVersionLine" . }}`)
	requirementsSectionBuilder.WriteString("\n\n")
	requirementsSectionBuilder.WriteString("{{ end }}")
	requirementsSectionBuilder.WriteString("{{ if .Dependencies }}")
	requirementsSectionBuilder.WriteString(`{{ template "chart.requirementsTable" . }}`)
	requirementsSectionBuilder.WriteString("{{ end }}")
	requirementsSectionBuilder.WriteString("{{ end }}")
	requirementsSectionBuilder.WriteString("{{ end }}")

return requirementsSectionBuilder.String()
}

func getValuesTableTemplates() string {
	valuesSectionBuilder := strings.Builder{}
	valuesSectionBuilder.WriteString(`{{ define "chart.valuesHeader" }}## Values{{ end }}`)

valuesSectionBuilder.WriteString(`{{ define "chart.valuesTable" }}`)
	valuesSectionBuilder.WriteString("| Key | Type | Default | Description |\n")
	valuesSectionBuilder.WriteString("|-----|------|---------|-------------|\n")
	valuesSectionBuilder.WriteString("  {{- range .Values }}")
	valuesSectionBuilder.WriteString("\n| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |")
	valuesSectionBuilder.WriteString("  {{- end }}")
	valuesSectionBuilder.WriteString("{{ end }}")

valuesSectionBuilder.WriteString(`{{ define "chart.valuesSection" }}`)
	valuesSectionBuilder.WriteString("{{ if .Values }}")
	valuesSectionBuilder.WriteString(`{{ template "chart.valuesHeader" . }}`)
	valuesSectionBuilder.WriteString("\n\n")
	valuesSectionBuilder.WriteString(`{{ template "chart.valuesTable" . }}`)
	valuesSectionBuilder.WriteString("{{ end }}")
	valuesSectionBuilder.WriteString("{{ end }}")

// For HTML tables
	valuesSectionBuilder.WriteString(`
{{ define "chart.valueDefaultColumnRender" }}
{{- $defaultValue := (default .Default .AutoDefault)  -}}
{{- $notationType := .NotationType }}
{{- if (and (hasPrefix "` + "`" + `" $defaultValue) (hasSuffix "` + "`" + `" $defaultValue) ) -}}
{{- $defaultValue = (toPrettyJson (fromJson (trimAll "` + "`" + `" (default .Default .AutoDefault) ) ) ) -}}
{{- $notationType = "json" }}
{{- end -}}
<pre lang="{{ $notationType }}">
{{- if (eq $notationType "tpl" ) }}
{{ .Key }}: |
{{- $defaultValue | nindent 2 }}
{{- else }}
{{ $defaultValue }}
{{- end }}
</pre>
{{ end }}

{{ define "chart.valuesTableHtml" }}
<table>
	<thead>
		<th>Key</th>
		<th>Type</th>
		<th>Default</th>
		<th>Description</th>
	</thead>
	<tbody>
	{{- range .Values }}
		<tr>
			<td>{{ .Key }}</td>
			<td>{{ .Type }}</td>
			<td>{{ template "chart.valueDefaultColumnRender" . }}</td>
			<td>{{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }}</td>
		</tr>
	{{- end }}
	</tbody>
</table>
{{ end }}

{{ define "chart.valuesSectionHtml" }}
{{ if .Values }}
{{ template "chart.valuesHeader" . }}
{{ template "chart.valuesTableHtml" . }}
{{ end }}
{{ end }}
		`)

return valuesSectionBuilder.String()
}

func getHelmDocsVersionTemplates() string {
	versionSectionBuilder := strings.Builder{}
	versionSectionBuilder.WriteString(`{{ define "helm-docs.version" }}{{ if .HelmDocsVersion }}{{ .HelmDocsVersion }}{{ end }}{{ end }}`)
	versionSectionBuilder.WriteString(`{{ define "helm-docs.versionFooter" }}`)
	versionSectionBuilder.WriteString("{{ if .HelmDocsVersion }}\n")
	versionSectionBuilder.WriteString("----------------------------------------------\n")
	versionSectionBuilder.WriteString("Autogenerated from chart metadata using [helm-docs v{{ .HelmDocsVersion }}](https://github.com/norwoodj/helm-docs/releases/v{{ .HelmDocsVersion }})")
	versionSectionBuilder.WriteString("{{ end }}")
	versionSectionBuilder.WriteString("{{ end }}")

return versionSectionBuilder.String()
}

func getDocumentationTemplate(chartDirectory string, chartSearchRoot string, templateFiles []string) (string, error) {
	templateFilesForChart := make([]string, 0)

var templateNotFound bool

for _, templateFile := range templateFiles {
		var fullTemplatePath string

if util.IsRelativePath(templateFile) {
			fullTemplatePath = filepath.Join(chartSearchRoot, templateFile)
		} else if util.IsBaseFilename(templateFile) {
			fullTemplatePath = filepath.Join(chartDirectory, templateFile)
		} else {
			fullTemplatePath = templateFile
		}

if _, err := os.Stat(fullTemplatePath); os.IsNotExist(err) {
			log.Debugf("Did not find template file %s for chart %s, using default template", templateFile, chartDirectory)

templateNotFound = true
			continue
		}

templateFilesForChart = append(templateFilesForChart, fullTemplatePath)
	}

log.Debugf("Using template files %s for chart %s", templateFiles, chartDirectory)
	allTemplateContents := make([]byte, 0)
	for _, templateFileForChart := range templateFilesForChart {
		templateContents, err := ioutil.ReadFile(templateFileForChart)
		if err != nil {
			return "", err
		}
		allTemplateContents = append(allTemplateContents, templateContents...)
	}

if templateNotFound {
		allTemplateContents = append(allTemplateContents, []byte(defaultDocumentationTemplate)...)
	}

return string(allTemplateContents), nil
}

func getDocumentationTemplates(chartDirectory string, chartSearchRoot string, templateFiles []string, badgeStyle string) ([]string, error) {
	documentationTemplate, err := getDocumentationTemplate(chartDirectory, chartSearchRoot, templateFiles)

if err != nil {
		log.Errorf("Failed to read documentation template for chart %s: %s", chartDirectory, err)
		return nil, err
	}

return []string{
		getNameTemplate(),
		getHeaderTemplate(),
		getDeprecatedTemplate(),
		getAppVersionTemplate(badgeStyle),
		getBadgesTemplates(),
		getDescriptionTemplate(),
		getVersionTemplates(badgeStyle),
		getTypeTemplate(badgeStyle),
		getSourceLinkTemplates(),
		getRequirementsTableTemplates(),
		getValuesTableTemplates(),
		getHomepageTemplate(),
		getMaintainersTemplate(),
		getHelmDocsVersionTemplates(),
		documentationTemplate,
	}, nil
}

func newChartDocumentationTemplate(chartDocumentationInfo helm.ChartDocumentationInfo, chartSearchRoot string, templateFiles []string, badgeStyle string) (*template.Template, error) {
	documentationTemplate := template.New(chartDocumentationInfo.ChartDirectory)
	documentationTemplate.Funcs(sprig.TxtFuncMap())
	goTemplateList, err := getDocumentationTemplates(chartDocumentationInfo.ChartDirectory, chartSearchRoot, templateFiles, badgeStyle)

if err != nil {
		return nil, err
	}

for _, t := range goTemplateList {
		_, err := documentationTemplate.Parse(t)

if err != nil {
			return nil, err
		}
	}

return documentationTemplate, nil
}
0707010000016D000081A400000000000000000000000164C03CE4000002C4000000000000000000000000000000000000002F00000000helm-docs-1.11.1/pkg/document/template_test.gopackage document

import (
	"testing"

"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func TestGetDocumentationTemplate(t *testing.T) {
	tpl, err := getDocumentationTemplate(".", ".", []string{"testdata/nonexistent.md.gotmpl"})

require.NoError(t, err)
	assert.Equal(t, defaultDocumentationTemplate, tpl)
}

func TestGetDocumentationTemplate_LoadDefaultOnNotFound(t *testing.T) {
	tpl, err := getDocumentationTemplate(".", ".", []string{
		"testdata/README.md.gotmpl",
		"testdata/nonexistent.md.gotmpl",
		"testdata/README2.md.gotmpl",
	})

const expected = "hello\nhello again\n" + defaultDocumentationTemplate

require.NoError(t, err)
	assert.Equal(t, expected, tpl)
}
0707010000016E000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000002700000000helm-docs-1.11.1/pkg/document/testdata0707010000016F000081A400000000000000000000000164C03CE400000006000000000000000000000000000000000000003800000000helm-docs-1.11.1/pkg/document/testdata/README.md.gotmplhello
07070100000170000081A400000000000000000000000164C03CE40000000C000000000000000000000000000000000000003900000000helm-docs-1.11.1/pkg/document/testdata/README2.md.gotmplhello again
07070100000171000081A400000000000000000000000164C03CE400000705000000000000000000000000000000000000002600000000helm-docs-1.11.1/pkg/document/util.gopackage document

import (
	log "github.com/sirupsen/logrus"
	"gopkg.in/yaml.v3"
)

const (
	AlphaNumSortOrder = "alphanum"
	FileSortOrder     = "file"
)

// The json library can only marshal maps with string keys, and so all of our lists and maps that go into documentation
// must be converted to have only string keys before marshalling
func convertHelmValuesToJsonable(values *yaml.Node) interface{} {
	switch values.Kind {
	case yaml.MappingNode:
		convertedMap := make(map[string]interface{})

for i := 0; i < len(values.Content); i += 2 {
			k := values.Content[i]
			v := values.Content[i+1]
			convertedMap[k.Value] = convertHelmValuesToJsonable(v)
		}

return convertedMap
	case yaml.SequenceNode:
		convertedList := make([]interface{}, 0)

for _, v := range values.Content {
			convertedList = append(convertedList, convertHelmValuesToJsonable(v))
		}

return convertedList
	case yaml.AliasNode:
		return convertHelmValuesToJsonable(values.Alias)
	case yaml.ScalarNode:
		switch values.Tag {
		case nullTag:
			return nil
		case strTag:
			fallthrough
		case timestampTag:
			return values.Value
		case intTag:
			var decodedValue int
			err := values.Decode(&decodedValue)
			if err != nil {
				log.Errorf("Failed to decode value from yaml node value %s", values.Value)
				return 0
			}
			return decodedValue
		case floatTag:
			var decodedValue float64
			err := values.Decode(&decodedValue)
			if err != nil {
				log.Errorf("Failed to decode value from yaml node value %s", values.Value)
				return 0
			}
			return decodedValue

case boolTag:
			var decodedValue bool
			err := values.Decode(&decodedValue)
			if err != nil {
				log.Errorf("Failed to decode value from yaml node value %s", values.Value)
				return 0
			}
			return decodedValue
		}
	}

return nil
}
07070100000172000081A400000000000000000000000164C03CE4000035F4000000000000000000000000000000000000002800000000helm-docs-1.11.1/pkg/document/values.gopackage document

import (
	"bytes"
	"encoding/json"
	"fmt"
	"strings"

"github.com/norwoodj/helm-docs/pkg/helm"
	"gopkg.in/yaml.v3"
)

const (
	boolType   = "bool"
	floatType  = "float"
	intType    = "int"
	listType   = "list"
	objectType = "object"
	stringType = "string"
	yamlType   = "yaml"
	tplType    = "tpl"
)

// Yaml tags that differentiate the type of scalar object in the node
const (
	nullTag      = "!!null"
	boolTag      = "!!bool"
	strTag       = "!!str"
	intTag       = "!!int"
	floatTag     = "!!float"
	timestampTag = "!!timestamp"
)

func formatNextListKeyPrefix(prefix string, index int) string {
	return fmt.Sprintf("%s[%d]", prefix, index)
}

func formatNextObjectKeyPrefix(prefix string, key string) string {
	var escapedKey string
	var nextPrefix string

if strings.Contains(key, ".") || strings.Contains(key, " ") {
		escapedKey = fmt.Sprintf(`"%s"`, key)
	} else {
		escapedKey = key
	}

if prefix != "" {
		nextPrefix = fmt.Sprintf("%s.%s", prefix, escapedKey)
	} else {
		nextPrefix = fmt.Sprintf("%s", escapedKey)
	}

return nextPrefix
}

func getTypeName(value interface{}) string {
	switch value.(type) {
	case bool:
		return boolType
	case float64:
		return floatType
	case int:
		return intType
	case string:
		return stringType
	case []interface{}:
		return listType
	case map[string]interface{}:
		return objectType
	}

return ""
}

func parseNilValueType(key string, description helm.ChartValueDescription, autoDescription helm.ChartValueDescription, column int, lineNumber int) valueRow {
	if len(description.Description) == 0 {
		description.Description = autoDescription.Description
	}

var t string
	if description.ValueType != "" {
		t = description.ValueType
	} else if autoDescription.ValueType != "" {
		// Use whatever the type recognized by autoDescription parser
		t = autoDescription.ValueType
	} else {
		t = stringType
	}

// only set description.Default if no fallback (autoDescription.Default) is available
	if description.Default == "" && autoDescription.Default == "" {
		description.Default = "`nil`"
	}

return valueRow{
		Key:             key,
		Type:            t,
		AutoDefault:     autoDescription.Default,
		Default:         description.Default,
		AutoDescription: autoDescription.Description,
		Description:     description.Description,
		Column:          column,
		LineNumber:      lineNumber,
	}
}

func jsonMarshalNoEscape(key string, value interface{}) (string, error) {
	outputBuffer := &bytes.Buffer{}
	valueEncoder := json.NewEncoder(outputBuffer)
	valueEncoder.SetEscapeHTML(false)
	err := valueEncoder.Encode(value)

if err != nil {
		return "", fmt.Errorf("failed to marshal default value for %s to json: %s", key, err)
	}

return strings.TrimRight(outputBuffer.String(), "\n"), nil
}

func getDescriptionFromNode(node *yaml.Node) helm.ChartValueDescription {
	if node == nil {
		return helm.ChartValueDescription{}
	}

if node.HeadComment == "" {
		return helm.ChartValueDescription{}
	}

if !strings.Contains(node.HeadComment, helm.PrefixComment) {
		return helm.ChartValueDescription{}
	}
	commentLines := strings.Split(node.HeadComment, "\n")
	keyFromComment, c := helm.ParseComment(commentLines)
	if keyFromComment != "" {
		return helm.ChartValueDescription{}
	}

return c
}

func createValueRow(
	key string,
	value interface{},
	description helm.ChartValueDescription,
	autoDescription helm.ChartValueDescription,
	column int,
	lineNumber int,
) (valueRow, error) {
	if value == nil {
		return parseNilValueType(key, description, autoDescription, column, lineNumber), nil
	}

autoDefaultValue := autoDescription.Default
	defaultValue := description.Default
	notationType := autoDescription.NotationType
	defaultType := getTypeName(value)
	if description.ValueType != "" {
		defaultType = description.ValueType
	} else if autoDescription.ValueType != "" {
		defaultType = autoDescription.ValueType
	} else if notationType != "" {
		// If nothing can be inferred then infer from notationType
		defaultType = notationType
	}

if defaultValue == "" && autoDefaultValue == "" && notationType == "" {
		jsonEncodedValue, err := jsonMarshalNoEscape(key, value)
		if err != nil {
			return valueRow{}, fmt.Errorf("failed to marshal default value for %s to json: %s", key, err)
		}

defaultValue = fmt.Sprintf("`%s`", jsonEncodedValue)
	}

if defaultValue == "" && autoDefaultValue == "" && notationType != "" {
		// We want to render custom styles for custom NotationType
		// So, output a raw default value for this and let the template handle it
		defaultValue = fmt.Sprintf("%s", value)
	}

return valueRow{
		Key:             key,
		Type:            defaultType,
		NotationType:    notationType,
		AutoDefault:     autoDescription.Default,
		Default:         defaultValue,
		AutoDescription: autoDescription.Description,
		Description:     description.Description,
		Column:          column,
		LineNumber:      lineNumber,
	}, nil
}

func createValueRowsFromList(
	prefix string,
	key *yaml.Node,
	values *yaml.Node,
	keysToDescriptions map[string]helm.ChartValueDescription,
	documentLeafNodes bool,
) ([]valueRow, error) {
	description, hasDescription := keysToDescriptions[prefix]
	autoDescription := getDescriptionFromNode(key)

// If we encounter an empty list, it should be documented if no parent object or list had a description or if this
	// list has a description
	if len(values.Content) == 0 {
		if !(documentLeafNodes || hasDescription || autoDescription.Description != "") {
			return []valueRow{}, nil
		}

emptyListRow, err := createValueRow(prefix, make([]interface{}, 0), description, autoDescription, key.Column, key.Line)
		if err != nil {
			return nil, err
		}

return []valueRow{emptyListRow}, nil
	}

valueRows := make([]valueRow, 0)

// We have a nonempty list with a description, document it, and mark that leaf nodes underneath it should not be
	// documented without descriptions
	if hasDescription || (autoDescription.Description != "" && autoDescription.NotationType == "") {
		jsonableObject := convertHelmValuesToJsonable(values)
		listRow, err := createValueRow(prefix, jsonableObject, description, autoDescription, key.Column, key.Line)

if err != nil {
			return nil, err
		}

valueRows = append(valueRows, listRow)
		documentLeafNodes = false
	} else if hasDescription || (autoDescription.Description != "" && autoDescription.NotationType != "") {
		// If it has NotationType described, then use that
		var notationValue interface{}
		var err error
		var listRow valueRow
		switch autoDescription.NotationType {
		case yamlType:
			notationValue, err = yaml.Marshal(values)
			if err != nil {
				return nil, err
			}

listRow, err = createValueRow(prefix, notationValue, description, autoDescription, key.Column, key.Line)

if err != nil {
				return nil, err
			}
		default:
			// Any other case means we let the template renderer to decide how to
			// format the default value. But the value are stored as raw string
			fallthrough
		case tplType:
			notationValue = values.Value
			listRow, err = createValueRow(prefix, notationValue, description, autoDescription, key.Column, key.Line)

if err != nil {
				return nil, err
			}
		}

valueRows = append(valueRows, listRow)
		documentLeafNodes = false
	}

// Generate documentation rows for all list items and their potential sub-fields
	for i, v := range values.Content {
		nextPrefix := formatNextListKeyPrefix(prefix, i)
		valueRowsForListField, err := createValueRowsFromField(nextPrefix, v, v, keysToDescriptions, documentLeafNodes)

if err != nil {
			return nil, err
		}

valueRows = append(valueRows, valueRowsForListField...)
	}

return valueRows, nil
}

func createValueRowsFromObject(
	nextPrefix string,
	key *yaml.Node,
	values *yaml.Node,
	keysToDescriptions map[string]helm.ChartValueDescription,
	documentLeafNodes bool,
) ([]valueRow, error) {
	description, hasDescription := keysToDescriptions[nextPrefix]
	autoDescription := getDescriptionFromNode(key)

if len(values.Content) == 0 {
		// if the first level of recursion has no values, then there are no values at all, and so we return zero rows of documentation
		if nextPrefix == "" {
			return []valueRow{}, nil
		}

// Otherwise, we have a leaf empty object node that should be documented if no object up the recursion chain had
		// a description or if this object has a description
		if !(documentLeafNodes || hasDescription || autoDescription.Description != "") {
			return []valueRow{}, nil
		}

documentedRow, err := createValueRow(nextPrefix, make(map[string]interface{}), description, autoDescription, key.Column, key.Line)
		return []valueRow{documentedRow}, err
	}

valueRows := make([]valueRow, 0)

// We have a nonempty object with a description, document it, and mark that leaf nodes underneath it should not be
	// documented without descriptions
	if hasDescription || (autoDescription.Description != "" && autoDescription.NotationType == "") {
		jsonableObject := convertHelmValuesToJsonable(values)
		objectRow, err := createValueRow(nextPrefix, jsonableObject, description, autoDescription, key.Column, key.Line)

if err != nil {
			return nil, err
		}

valueRows = append(valueRows, objectRow)
		documentLeafNodes = false
	} else if hasDescription || (autoDescription.Description != "" && autoDescription.NotationType != "") {

// If it has NotationType described, then use that
		var notationValue interface{}
		var err error
		var objectRow valueRow
		switch autoDescription.NotationType {
		case yamlType:
			notationValue, err = yaml.Marshal(values)
			if err != nil {
				return nil, err
			}

objectRow, err = createValueRow(nextPrefix, notationValue, description, autoDescription, key.Column, key.Line)

if err != nil {
				return nil, err
			}

default:
			// Any other case means we let the template renderer to decide how to
			// format the default value. But the value are stored as raw string
			fallthrough
		case tplType:
			notationValue = values.Value
			objectRow, err = createValueRow(nextPrefix, notationValue, description, autoDescription, key.Column, key.Line)

if err != nil {
				return nil, err
			}
		}

valueRows = append(valueRows, objectRow)
		documentLeafNodes = false
	}

for i := 0; i < len(values.Content); i += 2 {
		k := values.Content[i]
		v := values.Content[i+1]
		nextPrefix := formatNextObjectKeyPrefix(nextPrefix, k.Value)
		valueRowsForObjectField, err := createValueRowsFromField(nextPrefix, k, v, keysToDescriptions, documentLeafNodes)

if err != nil {
			return nil, err
		}

valueRows = append(valueRows, valueRowsForObjectField...)
	}

return valueRows, nil
}

func createValueRowsFromField(
	prefix string,
	key *yaml.Node,
	value *yaml.Node,
	keysToDescriptions map[string]helm.ChartValueDescription,
	documentLeafNodes bool,
) ([]valueRow, error) {
	switch value.Kind {
	case yaml.MappingNode:
		return createValueRowsFromObject(prefix, key, value, keysToDescriptions, documentLeafNodes)
	case yaml.SequenceNode:
		return createValueRowsFromList(prefix, key, value, keysToDescriptions, documentLeafNodes)
	case yaml.AliasNode:
		return createValueRowsFromField(prefix, key, value.Alias, keysToDescriptions, documentLeafNodes)
	case yaml.ScalarNode:
		autoDescription := getDescriptionFromNode(key)
		description, hasDescription := keysToDescriptions[prefix]
		if !(documentLeafNodes || hasDescription || autoDescription.Description != "") {
			return []valueRow{}, nil
		}

switch value.Tag {
		case nullTag:
			leafValueRow, err := createValueRow(prefix, nil, description, autoDescription, key.Column, key.Line)
			return []valueRow{leafValueRow}, err
		case strTag:
			// extra check to see if the node is a string, but @notationType was declared
			if autoDescription.NotationType != "" {
				var notationValue interface{}
				var err error
				var leafValueRow valueRow
				switch autoDescription.NotationType {
				case yamlType:
					notationValue, err = yaml.Marshal(value)
					if err != nil {
						return nil, err
					}

leafValueRow, err = createValueRow(prefix, notationValue, description, autoDescription, key.Column, key.Line)

if err != nil {
						return nil, err
					}

return []valueRow{leafValueRow}, err
				default:
					// Any other case means we let the template renderer to decide how to
					// format the default value. But the value are stored as raw string
					fallthrough
				case tplType:
					notationValue = value.Value
					leafValueRow, err = createValueRow(prefix, notationValue, description, autoDescription, key.Column, key.Line)

if err != nil {
						return nil, err
					}

return []valueRow{leafValueRow}, err
				}
			}
			fallthrough
		case timestampTag:
			leafValueRow, err := createValueRow(prefix, value.Value, description, autoDescription, key.Column, key.Line)
			return []valueRow{leafValueRow}, err
		case intTag:
			var decodedValue int
			err := value.Decode(&decodedValue)
			if err != nil {
				return []valueRow{}, err
			}

leafValueRow, err := createValueRow(prefix, decodedValue, description, autoDescription, key.Column, key.Line)
			return []valueRow{leafValueRow}, err
		case floatTag:
			var decodedValue float64
			err := value.Decode(&decodedValue)
			if err != nil {
				return []valueRow{}, err
			}
			leafValueRow, err := createValueRow(prefix, decodedValue, description, autoDescription, key.Column, key.Line)
			return []valueRow{leafValueRow}, err

case boolTag:
			var decodedValue bool
			err := value.Decode(&decodedValue)
			if err != nil {
				return []valueRow{}, err
			}
			leafValueRow, err := createValueRow(prefix, decodedValue, description, autoDescription, key.Column, key.Line)
			return []valueRow{leafValueRow}, err
		}
	}

return []valueRow{}, fmt.Errorf("invalid node type %d received", value.Kind)
}
07070100000173000081A400000000000000000000000164C03CE40000D42D000000000000000000000000000000000000002D00000000helm-docs-1.11.1/pkg/document/values_test.gopackage document

import (
	"strings"
	"testing"

"github.com/norwoodj/helm-docs/pkg/helm"
	"github.com/stretchr/testify/assert"
	"gopkg.in/yaml.v3"
)

func getSortedValuesTableRows(helmValues *yaml.Node, descriptions map[string]helm.ChartValueDescription) ([]valueRow, error) {
	// Note: This getSortedValuesTableRows function was added as a shim when getSortedValuesTableRows
	// was removed from the package. In the future it may make sense to rewrite the tests.

document := &yaml.Node{Kind: yaml.DocumentNode, Content: []*yaml.Node{helmValues}}
	valueRows, err := getUnsortedValueRows(document, descriptions)
	if err != nil {
		return nil, err
	}

sortValueRows(valueRows)

return valueRows, nil
}

func parseYamlValues(yamlValues string) *yaml.Node {
	var chartValues yaml.Node
	err := yaml.Unmarshal([]byte(strings.TrimSpace(yamlValues)), &chartValues)

if err != nil {
		panic(err)
	}

return chartValues.Content[0]
}

func TestEmptyValues(t *testing.T) {
	helmValues := parseYamlValues(`{}`)
	valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))
	assert.Nil(t, err)
	assert.Len(t, valuesRows, 0)
}

func TestSimpleValues(t *testing.T) {
	helmValues := parseYamlValues(`
echo: 0
foxtrot: true
hello: "world"
oscar: 3.14159
	`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 4)

assert.Equal(t, "echo", valuesRows[0].Key)
	assert.Equal(t, intType, valuesRows[0].Type, intType)
	assert.Equal(t, "`0`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "foxtrot", valuesRows[1].Key)
	assert.Equal(t, boolType, valuesRows[1].Type)
	assert.Equal(t, "`true`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

assert.Equal(t, "hello", valuesRows[2].Key)
	assert.Equal(t, stringType, valuesRows[2].Type)
	assert.Equal(t, "`\"world\"`", valuesRows[2].Default)
	assert.Equal(t, "", valuesRows[2].AutoDefault)
	assert.Equal(t, "", valuesRows[2].Description)
	assert.Equal(t, "", valuesRows[2].AutoDescription)

assert.Equal(t, "oscar", valuesRows[3].Key)
	assert.Equal(t, floatType, valuesRows[3].Type)
	assert.Equal(t, "`3.14159`", valuesRows[3].Default)
	assert.Equal(t, "", valuesRows[3].AutoDefault)
	assert.Equal(t, "", valuesRows[3].Description)
	assert.Equal(t, "", valuesRows[3].AutoDescription)
}

func TestSimpleValuesWithDescriptions(t *testing.T) {
	helmValues := parseYamlValues(`
echo: 0
foxtrot: true
hello: "world"
oscar: 3.14159
	`)

descriptions := map[string]helm.ChartValueDescription{
		"echo":    {Description: "echo"},
		"foxtrot": {Description: "foxtrot"},
		"hello":   {Description: "hello"},
		"oscar":   {Description: "oscar"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 4)

assert.Equal(t, "echo", valuesRows[0].Key)
	assert.Equal(t, intType, valuesRows[0].Type, intType)
	assert.Equal(t, "`0`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "echo", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "foxtrot", valuesRows[1].Key)
	assert.Equal(t, boolType, valuesRows[1].Type)
	assert.Equal(t, "`true`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "foxtrot", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

assert.Equal(t, "hello", valuesRows[2].Key)
	assert.Equal(t, stringType, valuesRows[2].Type)
	assert.Equal(t, "`\"world\"`", valuesRows[2].Default)
	assert.Equal(t, "", valuesRows[2].AutoDefault)
	assert.Equal(t, "hello", valuesRows[2].Description)
	assert.Equal(t, "", valuesRows[2].AutoDescription)

assert.Equal(t, "oscar", valuesRows[3].Key)
	assert.Equal(t, floatType, valuesRows[3].Type)
	assert.Equal(t, "`3.14159`", valuesRows[3].Default)
	assert.Equal(t, "", valuesRows[3].AutoDefault)
	assert.Equal(t, "oscar", valuesRows[3].Description)
	assert.Equal(t, "", valuesRows[3].AutoDescription)
}

func TestSimpleValuesWithDescriptionsAndDefaults(t *testing.T) {
	helmValues := parseYamlValues(`
echo: 0
foxtrot: true
hello: "world"
oscar: 3.14159
	`)

descriptions := map[string]helm.ChartValueDescription{
		"echo":    {Description: "echo", Default: "some"},
		"foxtrot": {Description: "foxtrot", Default: "explicit"},
		"hello":   {Description: "hello", Default: "default"},
		"oscar":   {Description: "oscar", Default: "values"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 4)

assert.Equal(t, "echo", valuesRows[0].Key)
	assert.Equal(t, intType, valuesRows[0].Type, intType)
	assert.Equal(t, "some", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "echo", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "foxtrot", valuesRows[1].Key)
	assert.Equal(t, boolType, valuesRows[1].Type)
	assert.Equal(t, "explicit", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "foxtrot", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

assert.Equal(t, "hello", valuesRows[2].Key)
	assert.Equal(t, stringType, valuesRows[2].Type)
	assert.Equal(t, "default", valuesRows[2].Default)
	assert.Equal(t, "", valuesRows[2].AutoDefault)
	assert.Equal(t, "hello", valuesRows[2].Description)
	assert.Equal(t, "", valuesRows[2].AutoDescription)

assert.Equal(t, "oscar", valuesRows[3].Key)
	assert.Equal(t, floatType, valuesRows[3].Type)
	assert.Equal(t, "values", valuesRows[3].Default)
	assert.Equal(t, "", valuesRows[3].AutoDefault)
	assert.Equal(t, "oscar", valuesRows[3].Description)
	assert.Equal(t, "", valuesRows[3].AutoDescription)
}

func TestRecursiveValues(t *testing.T) {
	helmValues := parseYamlValues(`
recursive:
  echo: cat
oscar: dog
	`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "oscar", valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "`\"dog\"`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "recursive.echo", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "`\"cat\"`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)
}

func TestRecursiveValuesWithDescriptions(t *testing.T) {
	helmValues := parseYamlValues(`
recursive:
  echo: cat
oscar: dog
	`)

descriptions := map[string]helm.ChartValueDescription{
		"recursive.echo": {Description: "echo"},
		"oscar":          {Description: "oscar"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "oscar", valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "`\"dog\"`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "oscar", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "recursive.echo", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "`\"cat\"`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "echo", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)
}

func TestRecursiveValuesWithDescriptionsAndDefaults(t *testing.T) {
	helmValues := parseYamlValues(`
recursive:
  echo: cat
oscar: dog
	`)

descriptions := map[string]helm.ChartValueDescription{
		"recursive.echo": {Description: "echo", Default: "custom"},
		"oscar":          {Description: "oscar", Default: "default"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "oscar", valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "default", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "oscar", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "recursive.echo", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "custom", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "echo", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)
}

func TestEmptyObject(t *testing.T) {
	helmValues := parseYamlValues(`
recursive: {}
oscar: dog
	`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "oscar", valuesRows[0].Key, "oscar")
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "`\"dog\"`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "recursive", valuesRows[1].Key)
	assert.Equal(t, objectType, valuesRows[1].Type)
	assert.Equal(t, "`{}`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)
}

func TestEmptyObjectWithDescription(t *testing.T) {
	helmValues := parseYamlValues(`
recursive: {}
oscar: dog
	`)

descriptions := map[string]helm.ChartValueDescription{
		"recursive": {Description: "an empty object"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "recursive", valuesRows[1].Key)
	assert.Equal(t, objectType, valuesRows[1].Type)
	assert.Equal(t, "`{}`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "an empty object", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)
}

func TestEmptyObjectWithDescriptionAndDefaults(t *testing.T) {
	helmValues := parseYamlValues(`
recursive: {}
oscar: dog
	`)

descriptions := map[string]helm.ChartValueDescription{
		"recursive": {Description: "an empty object", Default: "default"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "recursive", valuesRows[1].Key)
	assert.Equal(t, objectType, valuesRows[1].Type)
	assert.Equal(t, "default", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "an empty object", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)
}
func TestEmptyList(t *testing.T) {
	helmValues := parseYamlValues(`
birds: []
echo: cat
	`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "birds", valuesRows[0].Key)
	assert.Equal(t, listType, valuesRows[0].Type)
	assert.Equal(t, "`[]`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "echo", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "`\"cat\"`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)
}

func TestEmptyListWithDescriptions(t *testing.T) {
	helmValues := parseYamlValues(`
birds: []
echo: cat
	`)

descriptions := map[string]helm.ChartValueDescription{
		"birds": {Description: "birds"},
		"echo":  {Description: "echo"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "birds", valuesRows[0].Key)
	assert.Equal(t, listType, valuesRows[0].Type)
	assert.Equal(t, "`[]`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "birds", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "echo", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "`\"cat\"`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "echo", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)
}

func TestEmptyListWithDescriptionsAndDefaults(t *testing.T) {
	helmValues := parseYamlValues(`
birds: []
echo: cat
	`)

descriptions := map[string]helm.ChartValueDescription{
		"birds": {Description: "birds", Default: "explicit"},
		"echo":  {Description: "echo", Default: "default value"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "birds", valuesRows[0].Key)
	assert.Equal(t, listType, valuesRows[0].Type)
	assert.Equal(t, "explicit", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "birds", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "echo", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "default value", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "echo", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)
}

func TestListOfStrings(t *testing.T) {
	helmValues := parseYamlValues(`
cats: [echo, foxtrot]
	`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "cats[0]", valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "`\"echo\"`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "cats[1]", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "`\"foxtrot\"`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

}

func TestListOfStringsWithDescriptions(t *testing.T) {
	helmValues := parseYamlValues(`
cats: [echo, foxtrot]
	`)

descriptions := map[string]helm.ChartValueDescription{
		"cats[0]": {Description: "the black one"},
		"cats[1]": {Description: "the friendly one"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "cats[0]", valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "`\"echo\"`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "the black one", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "cats[1]", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "`\"foxtrot\"`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "the friendly one", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

}

func TestListOfStringsWithDescriptionsAndDefaults(t *testing.T) {
	helmValues := parseYamlValues(`
cats: [echo, foxtrot]
	`)

descriptions := map[string]helm.ChartValueDescription{
		"cats[0]": {Description: "the black one", Default: "explicit"},
		"cats[1]": {Description: "the friendly one", Default: "default value"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "cats[0]", valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "explicit", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "the black one", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "cats[1]", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "default value", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "the friendly one", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

}

func TestListOfObjects(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  - elements: [echo, foxtrot]
    type: cat
  - elements: [oscar]
    type: dog
	`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 5)

assert.Equal(t, "animals[0].elements[0]", valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "`\"echo\"`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "animals[0].elements[1]", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "`\"foxtrot\"`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

assert.Equal(t, "animals[0].type", valuesRows[2].Key)
	assert.Equal(t, stringType, valuesRows[2].Type)
	assert.Equal(t, "`\"cat\"`", valuesRows[2].Default)
	assert.Equal(t, "", valuesRows[2].AutoDefault)
	assert.Equal(t, "", valuesRows[2].Description)
	assert.Equal(t, "", valuesRows[2].AutoDescription)

assert.Equal(t, "animals[1].elements[0]", valuesRows[3].Key)
	assert.Equal(t, stringType, valuesRows[3].Type)
	assert.Equal(t, "`\"oscar\"`", valuesRows[3].Default)
	assert.Equal(t, "", valuesRows[3].AutoDefault)
	assert.Equal(t, "", valuesRows[3].Description)
	assert.Equal(t, "", valuesRows[3].AutoDescription)

assert.Equal(t, "animals[1].type", valuesRows[4].Key)
	assert.Equal(t, stringType, valuesRows[4].Type)
	assert.Equal(t, "`\"dog\"`", valuesRows[4].Default)
	assert.Equal(t, "", valuesRows[4].AutoDefault)
	assert.Equal(t, "", valuesRows[4].Description)
	assert.Equal(t, "", valuesRows[4].AutoDescription)
}

func TestListOfObjectsWithDescriptions(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  - elements: [echo, foxtrot]
    type: cat
  - elements: [oscar]
    type: dog
	`)

descriptions := map[string]helm.ChartValueDescription{
		"animals[0].elements[0]": {Description: "the black one"},
		"animals[0].elements[1]": {Description: "the friendly one"},
		"animals[1].elements[0]": {Description: "the sleepy one"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 5)

assert.Equal(t, "animals[0].elements[0]", valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "`\"echo\"`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "the black one", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "animals[0].elements[1]", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "`\"foxtrot\"`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "the friendly one", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

assert.Equal(t, "animals[1].elements[0]", valuesRows[3].Key)
	assert.Equal(t, stringType, valuesRows[3].Type)
	assert.Equal(t, "`\"oscar\"`", valuesRows[3].Default)
	assert.Equal(t, "", valuesRows[3].AutoDefault)
	assert.Equal(t, "the sleepy one", valuesRows[3].Description)
	assert.Equal(t, "", valuesRows[3].AutoDescription)

func TestListOfObjectsWithDescriptionsAndDefaults(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  - elements: [echo, foxtrot]
    type: cat
  - elements: [oscar]
    type: dog
	`)

descriptions := map[string]helm.ChartValueDescription{
		"animals[0].elements[0]": {Description: "the black one", Default: "explicit"},
		"animals[0].elements[1]": {Description: "the friendly one", Default: "default"},
		"animals[1].elements[0]": {Description: "the sleepy one", Default: "value"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 5)

assert.Equal(t, "animals[0].elements[0]", valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "explicit", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "the black one", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "animals[0].elements[1]", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "default", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "the friendly one", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

assert.Equal(t, "animals[1].elements[0]", valuesRows[3].Key)
	assert.Equal(t, stringType, valuesRows[3].Type)
	assert.Equal(t, "value", valuesRows[3].Default)
	assert.Equal(t, "", valuesRows[3].AutoDefault)
	assert.Equal(t, "the sleepy one", valuesRows[3].Description)
	assert.Equal(t, "", valuesRows[3].AutoDescription)

func TestDescriptionOnList(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  - elements: [echo, foxtrot]
    type: cat
  - elements: [oscar]
    type: dog
	`)

descriptions := map[string]helm.ChartValueDescription{
		"animals": {Description: "all the animals of the house"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 1)

assert.Equal(t, "animals", valuesRows[0].Key)
	assert.Equal(t, listType, valuesRows[0].Type)
	assert.Equal(t, "`[{\"elements\":[\"echo\",\"foxtrot\"],\"type\":\"cat\"},{\"elements\":[\"oscar\"],\"type\":\"dog\"}]`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "all the animals of the house", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)
}

func TestDescriptionAndDefaultOnList(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  - elements: [echo, foxtrot]
    type: cat
  - elements: [oscar]
    type: dog
	`)

descriptions := map[string]helm.ChartValueDescription{
		"animals": {Description: "all the animals of the house", Default: "cat and dog"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 1)

assert.Equal(t, "animals", valuesRows[0].Key)
	assert.Equal(t, listType, valuesRows[0].Type)
	assert.Equal(t, "cat and dog", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "all the animals of the house", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)
}

func TestDescriptionAndDefaultOnObjectUnderList(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  - elements: [echo, foxtrot]
    type: cat
  - elements: [oscar]
    type: dog
	`)

descriptions := map[string]helm.ChartValueDescription{
		"animals[0]": {Description: "all the cats of the house", Default: "only cats here"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 3)

assert.Equal(t, "animals[0]", valuesRows[0].Key)
	assert.Equal(t, objectType, valuesRows[0].Type)
	assert.Equal(t, "only cats here", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "all the cats of the house", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "animals[1].elements[0]", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "`\"oscar\"`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

assert.Equal(t, "animals[1].type", valuesRows[2].Key)
	assert.Equal(t, stringType, valuesRows[2].Type)
	assert.Equal(t, "`\"dog\"`", valuesRows[2].Default)
	assert.Equal(t, "", valuesRows[2].AutoDefault)
	assert.Equal(t, "", valuesRows[2].Description)
	assert.Equal(t, "", valuesRows[2].AutoDescription)
}

func TestDescriptionOnObjectUnderObject(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  byTrait:
    friendly: [foxtrot, oscar]
    mean: [echo]
    sleepy: [oscar]
	`)

descriptions := map[string]helm.ChartValueDescription{
		"animals.byTrait": {Description: "animals listed by their various characteristics"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 1)

assert.Equal(t, "animals.byTrait", valuesRows[0].Key)
	assert.Equal(t, objectType, valuesRows[0].Type)
	assert.Equal(t, "`{\"friendly\":[\"foxtrot\",\"oscar\"],\"mean\":[\"echo\"],\"sleepy\":[\"oscar\"]}`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "animals listed by their various characteristics", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)
}

func TestDescriptionAndDefaultOnObjectUnderObject(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  byTrait:
    friendly: [foxtrot, oscar]
    mean: [echo]
    sleepy: [oscar]
	`)

descriptions := map[string]helm.ChartValueDescription{
		"animals.byTrait": {Description: "animals listed by their various characteristics", Default: "animals, you know"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 1)

assert.Equal(t, "animals.byTrait", valuesRows[0].Key)
	assert.Equal(t, objectType, valuesRows[0].Type)
	assert.Equal(t, "animals, you know", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "animals listed by their various characteristics", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)
}

func TestDescriptionsDownChain(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  byTrait:
    friendly: [foxtrot, oscar]
    mean: [echo]
    sleepy: [oscar]
	`)

descriptions := map[string]helm.ChartValueDescription{
		"animals":                     {Description: "animal stuff"},
		"animals.byTrait":             {Description: "animals listed by their various characteristics"},
		"animals.byTrait.friendly":    {Description: "the friendly animals of the house"},
		"animals.byTrait.friendly[0]": {Description: "best cat ever"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 4)

assert.Equal(t, "animals", valuesRows[0].Key)
	assert.Equal(t, objectType, valuesRows[0].Type)
	assert.Equal(t, "`{\"byTrait\":{\"friendly\":[\"foxtrot\",\"oscar\"],\"mean\":[\"echo\"],\"sleepy\":[\"oscar\"]}}`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "animal stuff", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "animals.byTrait", valuesRows[1].Key)
	assert.Equal(t, objectType, valuesRows[1].Type)
	assert.Equal(t, "`{\"friendly\":[\"foxtrot\",\"oscar\"],\"mean\":[\"echo\"],\"sleepy\":[\"oscar\"]}`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "animals listed by their various characteristics", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

assert.Equal(t, "animals.byTrait.friendly", valuesRows[2].Key)
	assert.Equal(t, listType, valuesRows[2].Type)
	assert.Equal(t, "`[\"foxtrot\",\"oscar\"]`", valuesRows[2].Default)
	assert.Equal(t, "", valuesRows[2].AutoDefault)
	assert.Equal(t, "the friendly animals of the house", valuesRows[2].Description)
	assert.Equal(t, "", valuesRows[2].AutoDescription)

assert.Equal(t, "animals.byTrait.friendly[0]", valuesRows[3].Key)
	assert.Equal(t, stringType, valuesRows[3].Type)
	assert.Equal(t, "`\"foxtrot\"`", valuesRows[3].Default)
	assert.Equal(t, "", valuesRows[3].AutoDefault)
	assert.Equal(t, "best cat ever", valuesRows[3].Description)
	assert.Equal(t, "", valuesRows[3].AutoDescription)
}

func TestDescriptionsAndDefaultsDownChain(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  byTrait:
    friendly: [foxtrot, oscar]
    mean: [echo]
    sleepy: [oscar]
	`)

descriptions := map[string]helm.ChartValueDescription{
		"animals":                     {Description: "animal stuff", Default: "some"},
		"animals.byTrait":             {Description: "animals listed by their various characteristics", Default: "explicit"},
		"animals.byTrait.friendly":    {Description: "the friendly animals of the house", Default: "default"},
		"animals.byTrait.friendly[0]": {Description: "best cat ever", Default: "value"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 4)

assert.Equal(t, "animals", valuesRows[0].Key)
	assert.Equal(t, objectType, valuesRows[0].Type)
	assert.Equal(t, "some", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "animal stuff", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "animals.byTrait", valuesRows[1].Key)
	assert.Equal(t, objectType, valuesRows[1].Type)
	assert.Equal(t, "explicit", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "animals listed by their various characteristics", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

assert.Equal(t, "animals.byTrait.friendly", valuesRows[2].Key)
	assert.Equal(t, listType, valuesRows[2].Type)
	assert.Equal(t, "default", valuesRows[2].Default)
	assert.Equal(t, "", valuesRows[2].AutoDefault)
	assert.Equal(t, "the friendly animals of the house", valuesRows[2].Description)
	assert.Equal(t, "", valuesRows[2].AutoDescription)

assert.Equal(t, "animals.byTrait.friendly[0]", valuesRows[3].Key)
	assert.Equal(t, stringType, valuesRows[3].Type)
	assert.Equal(t, "value", valuesRows[3].Default)
	assert.Equal(t, "", valuesRows[3].AutoDefault)
	assert.Equal(t, "best cat ever", valuesRows[3].Description)
	assert.Equal(t, "", valuesRows[3].AutoDescription)
}

func TestNilValues(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  birds:
  birdCount:
  nonWeirdCats:
  undescribedCount:
	`)

descriptions := map[string]helm.ChartValueDescription{
		"animals.birdCount":        {ValueType: intType, Description: "the number of birds we have"},
		"animals.birds":            {ValueType: listType, Description: "the list of birds we have"},
		"animals.nonWeirdCats":     {Description: "the cats that we have that are not weird"},
		"animals.undescribedCount": {ValueType: intType, Description: ""},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 4)

assert.Equal(t, "animals.birdCount", valuesRows[0].Key)
	assert.Equal(t, intType, valuesRows[0].Type)
	assert.Equal(t, "`nil`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "the number of birds we have", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "animals.birds", valuesRows[1].Key)
	assert.Equal(t, listType, valuesRows[1].Type)
	assert.Equal(t, "`nil`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "the list of birds we have", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

assert.Equal(t, "animals.nonWeirdCats", valuesRows[2].Key)
	assert.Equal(t, stringType, valuesRows[2].Type)
	assert.Equal(t, "`nil`", valuesRows[2].Default)
	assert.Equal(t, "", valuesRows[2].AutoDefault)
	assert.Equal(t, "the cats that we have that are not weird", valuesRows[2].Description)
	assert.Equal(t, "", valuesRows[2].AutoDescription)

assert.Equal(t, "animals.undescribedCount", valuesRows[3].Key)
	assert.Equal(t, intType, valuesRows[3].Type)
	assert.Equal(t, "`nil`", valuesRows[3].Default)
	assert.Equal(t, "", valuesRows[3].AutoDefault)
	assert.Equal(t, "", valuesRows[3].Description)
	assert.Equal(t, "", valuesRows[3].AutoDescription)
}

func TestNilValuesWithDefaults(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  birds:
  birdCount:
  nonWeirdCats:
	`)

descriptions := map[string]helm.ChartValueDescription{
		"animals.birdCount":    {ValueType: intType, Description: "the number of birds we have", Default: "some"},
		"animals.birds":        {ValueType: listType, Description: "the list of birds we have", Default: "explicit"},
		"animals.nonWeirdCats": {Description: "the cats that we have that are not weird", Default: "default"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 3)

assert.Equal(t, "animals.birdCount", valuesRows[0].Key)
	assert.Equal(t, intType, valuesRows[0].Type)
	assert.Equal(t, "some", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "the number of birds we have", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, "animals.birds", valuesRows[1].Key)
	assert.Equal(t, listType, valuesRows[1].Type)
	assert.Equal(t, "explicit", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "the list of birds we have", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)

assert.Equal(t, "animals.nonWeirdCats", valuesRows[2].Key)
	assert.Equal(t, stringType, valuesRows[2].Type)
	assert.Equal(t, "default", valuesRows[2].Default)
	assert.Equal(t, "", valuesRows[2].AutoDefault)
	assert.Equal(t, "the cats that we have that are not weird", valuesRows[2].Description)
	assert.Equal(t, "", valuesRows[2].AutoDescription)
}

func TestKeysWithSpecialCharacters(t *testing.T) {
	helmValues := parseYamlValues(`
websites:
  stupidchess.jmn23.com: defunct
fullNames:
  John Norwood: me
`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, `fullNames."John Norwood"`, valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "`\"me\"`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, `websites."stupidchess.jmn23.com"`, valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "`\"defunct\"`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)
}

func TestKeysWithSpecialCharactersWithDescriptions(t *testing.T) {
	helmValues := parseYamlValues(`
websites:
  stupidchess.jmn23.com: defunct
fullNames:
  John Norwood: me
`)

descriptions := map[string]helm.ChartValueDescription{
		`fullNames."John Norwood"`:         {Description: "who am I"},
		`websites."stupidchess.jmn23.com"`: {Description: "status of the stupidchess website"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, `fullNames."John Norwood"`, valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "`\"me\"`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "who am I", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, `websites."stupidchess.jmn23.com"`, valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "`\"defunct\"`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "status of the stupidchess website", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)
}

func TestKeysWithSpecialCharactersWithDescriptionsAndDefaults(t *testing.T) {
	helmValues := parseYamlValues(`
websites:
  stupidchess.jmn23.com: defunct
fullNames:
  John Norwood: me
`)

descriptions := map[string]helm.ChartValueDescription{
		`fullNames."John Norwood"`:         {Description: "who am I", Default: "default"},
		`websites."stupidchess.jmn23.com"`: {Description: "status of the stupidchess website", Default: "value"},
	}

valuesRows, err := getSortedValuesTableRows(helmValues, descriptions)

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, `fullNames."John Norwood"`, valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "default", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "who am I", valuesRows[0].Description)
	assert.Equal(t, "", valuesRows[0].AutoDescription)

assert.Equal(t, `websites."stupidchess.jmn23.com"`, valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "value", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "status of the stupidchess website", valuesRows[1].Description)
	assert.Equal(t, "", valuesRows[1].AutoDescription)
}

func TestSimpleAutoDoc(t *testing.T) {
	helmValues := parseYamlValues(`
# -- on a scale of 0 to 9 how mean is echo
echo: 8

# -- is she friendly?
foxtrot: true

# doesn't show up
hello: "world"

# -- his favorite food in number format
oscar: 3.14159
	`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 4)

assert.Equal(t, "echo", valuesRows[0].Key)
	assert.Equal(t, intType, valuesRows[0].Type, intType)
	assert.Equal(t, "`8`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "on a scale of 0 to 9 how mean is echo", valuesRows[0].AutoDescription)

func TestAutoDocNested(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  cats:
    # -- on a scale of 0 to 9 how mean is echo
    echo: 8

# -- is she friendly?
    foxtrot: true

dogs:
# -- his favorite food in number format
    oscar: 3.14159
`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 3)

assert.Equal(t, "animals.cats.echo", valuesRows[0].Key)
	assert.Equal(t, intType, valuesRows[0].Type, intType)
	assert.Equal(t, "`8`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "on a scale of 0 to 9 how mean is echo", valuesRows[0].AutoDescription)

assert.Equal(t, "animals.cats.foxtrot", valuesRows[1].Key)
	assert.Equal(t, boolType, valuesRows[1].Type)
	assert.Equal(t, "`true`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "is she friendly?", valuesRows[1].AutoDescription)

assert.Equal(t, "animals.dogs.oscar", valuesRows[2].Key)
	assert.Equal(t, floatType, valuesRows[2].Type)
	assert.Equal(t, "`3.14159`", valuesRows[2].Default)
	assert.Equal(t, "", valuesRows[2].AutoDefault)
	assert.Equal(t, "", valuesRows[2].Description)
	assert.Equal(t, "his favorite food in number format", valuesRows[2].AutoDescription)
}

func TestAutoDocList(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  cats:
    # -- best cat, really
    - echo
    # -- trash cat, really
    - foxtrot
`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "animals.cats[0]", valuesRows[0].Key)
	assert.Equal(t, stringType, valuesRows[0].Type)
	assert.Equal(t, "`\"echo\"`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "best cat, really", valuesRows[0].AutoDescription)

assert.Equal(t, "animals.cats[1]", valuesRows[1].Key)
	assert.Equal(t, stringType, valuesRows[1].Type)
	assert.Equal(t, "`\"foxtrot\"`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "trash cat, really", valuesRows[1].AutoDescription)
}

func TestAutoDocListOfObjects(t *testing.T) {
	helmValues := parseYamlValues(`
animalLocations:
  # -- place with the most cats
  - place: home
    cats:
      - echo
      - foxtrot

# -- place with the fewest cats
  - place: work
    cats: []
`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "animalLocations[0]", valuesRows[0].Key)
	assert.Equal(t, objectType, valuesRows[0].Type)
	assert.Equal(t, "`{\"cats\":[\"echo\",\"foxtrot\"],\"place\":\"home\"}`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "place with the most cats", valuesRows[0].AutoDescription)

assert.Equal(t, "animalLocations[1]", valuesRows[1].Key)
	assert.Equal(t, objectType, valuesRows[1].Type)
	assert.Equal(t, "`{\"cats\":[],\"place\":\"work\"}`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "place with the fewest cats", valuesRows[1].AutoDescription)
}

func TestAutoMultilineDescription(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  # -- The best kind of animal probably, allow me to list their many varied benefits.
  # Cats are very funny, and quite friendly, in almost all cases
  # @default -- The list of cats that _I_ own
  cats:
      - echo
      - foxtrot
`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 1)

assert.Equal(t, "animals.cats", valuesRows[0].Key)
	assert.Equal(t, listType, valuesRows[0].Type)
	assert.Equal(t, "The list of cats that _I_ own", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "The best kind of animal probably, allow me to list their many varied benefits. Cats are very funny, and quite friendly, in almost all cases", valuesRows[0].AutoDescription)
}

func TestAutoMultilineDescriptionWithoutValue(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  # -- (list) I mean, dogs are quite nice too...
  # @default -- The list of dogs that _I_ own
  dogs:
`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 1)

assert.Equal(t, "animals.dogs", valuesRows[0].Key)
	assert.Equal(t, listType, valuesRows[0].Type)
	assert.Equal(t, "The list of dogs that _I_ own", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Default)
	assert.Equal(t, "I mean, dogs are quite nice too...", valuesRows[0].Description)
}

func TestMulticomment1(t *testing.T) {
	helmValues := parseYamlValues(`
# -- before desc
before: 1

# -- commented desc
#commented:

# -- after desc
after: 3
`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)

assert.Equal(t, "before", valuesRows[1].Key)
	assert.Equal(t, intType, valuesRows[1].Type, intType)
	assert.Equal(t, "`1`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "before desc", valuesRows[1].AutoDescription)

assert.Equal(t, "after", valuesRows[0].Key)
	assert.Equal(t, intType, valuesRows[0].Type)
	assert.Equal(t, "`3`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "after desc", valuesRows[0].AutoDescription)
}

func TestMulticomment2(t *testing.T) {
	helmValues := parseYamlValues(`
# -- before desc
before: 1

# -- this should show up
hasInnerComment: {}
    # -- this should not
	# show up
    # innerField: 1

# -- after desc
after: 3
`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 3)

assert.Equal(t, "hasInnerComment", valuesRows[2].Key)
	assert.Equal(t, objectType, valuesRows[2].Type, intType)
	assert.Equal(t, "`{}`", valuesRows[2].Default)
	assert.Equal(t, "", valuesRows[2].AutoDefault)
	assert.Equal(t, "", valuesRows[2].Description)
	assert.Equal(t, "this should show up", valuesRows[2].AutoDescription)

func TestIgnoreCommentedFields(t *testing.T) {
	helmValues := parseYamlValues(`
# -- Qux!
qux: 1

# must not appear
# must not appear too

foo:
  # -- Bar!
  bar: true
  # -- Baz!
  baz: false
`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 3)

assert.Equal(t, "qux", valuesRows[2].Key)
	assert.Equal(t, intType, valuesRows[2].Type)
	assert.Equal(t, "`1`", valuesRows[2].Default)
	assert.Equal(t, "", valuesRows[2].AutoDefault)
	assert.Equal(t, "", valuesRows[2].Description)
	assert.Equal(t, "Qux!", valuesRows[2].AutoDescription)

assert.Equal(t, "foo.baz", valuesRows[1].Key)
	assert.Equal(t, boolType, valuesRows[1].Type)
	assert.Equal(t, "`false`", valuesRows[1].Default)
	assert.Equal(t, "", valuesRows[1].AutoDefault)
	assert.Equal(t, "", valuesRows[1].Description)
	assert.Equal(t, "Baz!", valuesRows[1].AutoDescription)

assert.Equal(t, "foo.bar", valuesRows[0].Key)
	assert.Equal(t, boolType, valuesRows[0].Type)
	assert.Equal(t, "`true`", valuesRows[0].Default)
	assert.Equal(t, "", valuesRows[0].AutoDefault)
	assert.Equal(t, "", valuesRows[0].Description)
	assert.Equal(t, "Bar!", valuesRows[0].AutoDescription)
}

func TestMultilineRawDescription(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  # -- (list) I mean, dogs are quite nice too...
  # @raw
  #
  # List of default dogs:
  #  - Umbra
  #  - Penumbra
  #  - Somnus
  #
  # @default -- The list of dogs that _I_ own
  dogs:
`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 1)

func TestExtractValueNotationType(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  # -- (list) My animals lists
  # @notationType -- yaml
  cats:
   - mike
   - ralph
  # -- (list) My animal lists, but in tpl string
  # @notationType -- tpl
  catsInTpl: |
   {{- .Values.animals.cats }}

# -- (object) Declaring object as tpl (to be cascaded with tpl function)
  # @notationType -- tpl
  dinosaur: |
    name: hockney
    dynamicVar: {{ .Values.fromOtherProperty }}

# -- (object) Declaring object as yaml
  # @notationType -- yaml
  fish:
    name: nomoby
`)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 4)

assert.Equal(t, "animals.cats", valuesRows[0].Key)
	assert.Equal(t, listType, valuesRows[0].Type)
	assert.Equal(t, yamlType, valuesRows[0].NotationType)
	assert.Equal(t, "- mike\n- ralph\n", valuesRows[0].Default)
	assert.Equal(t, "My animals lists", valuesRows[0].AutoDescription)

assert.Equal(t, "animals.catsInTpl", valuesRows[1].Key)
	assert.Equal(t, listType, valuesRows[1].Type)
	assert.Equal(t, tplType, valuesRows[1].NotationType)
	assert.Equal(t, "{{- .Values.animals.cats }}\n", valuesRows[1].Default)
	assert.Equal(t, "My animal lists, but in tpl string", valuesRows[1].AutoDescription)

assert.Equal(t, "animals.dinosaur", valuesRows[2].Key)
	assert.Equal(t, objectType, valuesRows[2].Type)
	assert.Equal(t, tplType, valuesRows[2].NotationType)
	assert.Equal(t, "name: hockney\ndynamicVar: {{ .Values.fromOtherProperty }}\n", valuesRows[2].Default)
	assert.Equal(t, "Declaring object as tpl (to be cascaded with tpl function)", valuesRows[2].AutoDescription)

assert.Equal(t, "animals.fish", valuesRows[3].Key)
	assert.Equal(t, objectType, valuesRows[3].Type)
	assert.Equal(t, yamlType, valuesRows[3].NotationType)
	assert.Equal(t, "name: nomoby\n", valuesRows[3].Default)
	assert.Equal(t, "My animals lists", valuesRows[0].AutoDescription)
}

func TestExtractCustomDeclaredType(t *testing.T) {
	helmValues := parseYamlValues(`
animals:
  # -- (list/csv) My animals lists but annotated as csv field
  cats: mike,ralph

owner:
  # -- (string/email) This has to be email address
  # @notationType -- email
  email: "owner@home.org"
  `)

valuesRows, err := getSortedValuesTableRows(helmValues, make(map[string]helm.ChartValueDescription))

assert.Nil(t, err)
	assert.Len(t, valuesRows, 2)
	assert.Equal(t, "animals.cats", valuesRows[0].Key)
	// With custom value type, we can convey to the reader that this value is a list, but in a csv format
	assert.Equal(t, "list/csv", valuesRows[0].Type)
	assert.Equal(t, "`\"mike,ralph\"`", valuesRows[0].Default)
	assert.Equal(t, "My animals lists but annotated as csv field", valuesRows[0].AutoDescription)

assert.Equal(t, "owner.email", valuesRows[1].Key)
	assert.Equal(t, "string/email", valuesRows[1].Type)
	assert.Equal(t, "email", valuesRows[1].NotationType)
	// In case of custom notation type, value in Default must be raw string
	// So that template can handle the formatting.
	// In this case, email might be reformatted as <a href="mailto:owner@home.org">owner@home.org</a>
	assert.Equal(t, "owner@home.org", valuesRows[1].Default)
	assert.Equal(t, "This has to be email address", valuesRows[1].AutoDescription)
}
07070100000174000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000001A00000000helm-docs-1.11.1/pkg/helm07070100000175000081A400000000000000000000000164C03CE400000427000000000000000000000000000000000000002A00000000helm-docs-1.11.1/pkg/helm/chart_finder.gopackage helm

import (
	"os"
	"path/filepath"

"github.com/norwoodj/helm-docs/pkg/util"
	log "github.com/sirupsen/logrus"
	"github.com/spf13/viper"
)

func FindChartDirectories(chartSearchRoot string) ([]string, error) {
	ignoreFilename := viper.GetString("ignore-file")
	ignoreContext := util.NewIgnoreContext(ignoreFilename)
	chartDirs := make([]string, 0)

err := filepath.Walk(chartSearchRoot, func(path string, info os.FileInfo, err error) error {
		if err != nil {
			return err
		}

absolutePath, _ := filepath.Abs(path)

if info.IsDir() && ignoreContext.ShouldIgnore(absolutePath, info) {
			log.Debugf("Ignoring directory %s", path)
			return filepath.SkipDir
		}

if filepath.Base(path) == "Chart.yaml" {
			if ignoreContext.ShouldIgnore(absolutePath, info) {
				log.Debugf("Ignoring chart file %s", path)
				return nil
			}
			relativeChartDir, err := filepath.Rel(chartSearchRoot, filepath.Dir(path))

if err != nil {
				return err
			}

chartDirs = append(chartDirs, relativeChartDir)
		}

return nil
	})

return chartDirs, err
}
07070100000176000081A400000000000000000000000164C03CE4000026A7000000000000000000000000000000000000002800000000helm-docs-1.11.1/pkg/helm/chart_info.gopackage helm

import (
	"bufio"
	"fmt"
	"io/ioutil"
	"os"
	"path/filepath"
	"regexp"
	"sort"
	"strings"

log "github.com/sirupsen/logrus"
	"github.com/spf13/viper"
	"gopkg.in/yaml.v3"
)

var valuesDescriptionRegex = regexp.MustCompile("^\\s*#\\s*(.*)\\s+--\\s*(.*)$")
var rawDescriptionRegex = regexp.MustCompile("^\\s*#\\s+@raw")
var commentContinuationRegex = regexp.MustCompile("^\\s*#(\\s?)(.*)$")
var defaultValueRegex = regexp.MustCompile("^\\s*# @default -- (.*)$")
var valueTypeRegex = regexp.MustCompile("^\$(.*?)\$\\s*(.*)$")
var valueNotationTypeRegex = regexp.MustCompile("^\\s*#\\s+@notationType\\s+--\\s+(.*)$")

type ChartMetaMaintainer struct {
	Email string
	Name  string
	Url   string
}

type ChartMeta struct {
	ApiVersion  string `yaml:"apiVersion"`
	AppVersion  string `yaml:"appVersion"`
	KubeVersion string `yaml:"kubeVersion"`
	Name        string
	Deprecated  bool
	Description string
	Version     string
	Home        string
	Type        string
	Sources     []string
	Engine      string
	Maintainers []ChartMetaMaintainer
}

type ChartRequirementsItem struct {
	Name       string
	Version    string
	Repository string
	Alias      string
}

type ChartRequirements struct {
	Dependencies []ChartRequirementsItem
}

type ChartValueDescription struct {
	Description  string
	Default      string
	ValueType    string
	NotationType string
}

type ChartDocumentationInfo struct {
	ChartMeta
	ChartRequirements

ChartDirectory          string
	ChartValues             *yaml.Node
	ChartValuesDescriptions map[string]ChartValueDescription
}

type ChartValuesDocumentationParsingConfig struct {
	StrictMode                 bool
	AllowedMissingValuePaths   []string
	AllowedMissingValueRegexps []*regexp.Regexp
}

func getYamlFileContents(filename string) ([]byte, error) {
	if _, err := os.Stat(filename); os.IsNotExist(err) {
		return nil, err
	}

yamlFileContents, err := ioutil.ReadFile(filename)
	if err != nil {
		panic(err)
	}

return []byte(strings.Replace(string(yamlFileContents), "\r\n", "\n", -1)), nil
}

func isErrorInReadingNecessaryFile(filePath string, loadError error) bool {
	if loadError != nil {
		if os.IsNotExist(loadError) {
			log.Warnf("Required chart file %s missing. Skipping documentation for chart", filePath)
			return true
		} else {
			log.Warnf("Error occurred in reading chart file %s. Skipping documentation for chart", filePath)
			return true
		}
	}

return false
}

func parseChartFile(chartDirectory string) (ChartMeta, error) {
	chartYamlPath := filepath.Join(chartDirectory, "Chart.yaml")
	chartMeta := ChartMeta{}
	yamlFileContents, err := getYamlFileContents(chartYamlPath)

if isErrorInReadingNecessaryFile(chartYamlPath, err) {
		return chartMeta, err
	}

err = yaml.Unmarshal(yamlFileContents, &chartMeta)
	return chartMeta, err
}

func requirementKey(requirement ChartRequirementsItem) string {
	return fmt.Sprintf("%s/%s", requirement.Repository, requirement.Name)
}

func parseChartRequirementsFile(chartDirectory string, apiVersion string) (ChartRequirements, error) {
	var requirementsPath string

if apiVersion == "v1" {
		requirementsPath = filepath.Join(chartDirectory, "requirements.yaml")

if _, err := os.Stat(requirementsPath); os.IsNotExist(err) {
			return ChartRequirements{Dependencies: []ChartRequirementsItem{}}, nil
		}
	} else {
		requirementsPath = filepath.Join(chartDirectory, "Chart.yaml")
	}

chartRequirements := ChartRequirements{}
	yamlFileContents, err := getYamlFileContents(requirementsPath)

if isErrorInReadingNecessaryFile(requirementsPath, err) {
		return chartRequirements, err
	}

err = yaml.Unmarshal(yamlFileContents, &chartRequirements)
	if err != nil {
		return chartRequirements, err
	}

sort.Slice(chartRequirements.Dependencies[:], func(i, j int) bool {
		return requirementKey(chartRequirements.Dependencies[i]) < requirementKey(chartRequirements.Dependencies[j])
	})

return chartRequirements, nil
}

func removeIgnored(rootNode *yaml.Node, parentKind yaml.Kind) {
	newContent := make([]*yaml.Node, 0, len(rootNode.Content))
	for i := 0; i < len(rootNode.Content); i++ {
		node := rootNode.Content[i]
		if !strings.Contains(node.HeadComment, "@ignore") {
			removeIgnored(node, node.Kind)
			newContent = append(newContent, node)
		} else if parentKind == yaml.MappingNode {
			// for parentKind each yaml key is represented by two nodes
			i++
		}
	}
	rootNode.Content = newContent
}

func parseChartValuesFile(chartDirectory string) (yaml.Node, error) {
	valuesPath := filepath.Join(chartDirectory, viper.GetString("values-file"))
	yamlFileContents, err := getYamlFileContents(valuesPath)

var values yaml.Node
	if isErrorInReadingNecessaryFile(valuesPath, err) {
		return values, err
	}

err = yaml.Unmarshal(yamlFileContents, &values)
	removeIgnored(&values, values.Kind)
	return values, err
}

func checkDocumentation(rootNode *yaml.Node, comments map[string]ChartValueDescription, config ChartValuesDocumentationParsingConfig) error {
	if len(rootNode.Content) == 0 {
		return nil
	}
	valuesWithoutDocs := collectValuesWithoutDoc(rootNode.Content[0], comments, make([]string, 0))
	valuesWithoutDocsAfterIgnore := make([]string, 0)
	for _, valueWithoutDoc := range valuesWithoutDocs {
		ignored := false
		for _, ignorableValuePath := range config.AllowedMissingValuePaths {
			ignored = ignored || valueWithoutDoc == ignorableValuePath
		}
		for _, ignorableValueRegexp := range config.AllowedMissingValueRegexps {
			ignored = ignored || ignorableValueRegexp.MatchString(valueWithoutDoc)
		}
		if !ignored {
			valuesWithoutDocsAfterIgnore = append(valuesWithoutDocsAfterIgnore, valueWithoutDoc)
		}
	}
	if len(valuesWithoutDocsAfterIgnore) > 0 {
		return fmt.Errorf("values without documentation: \n%s", strings.Join(valuesWithoutDocsAfterIgnore, "\n"))
	}
	return nil
}

func collectValuesWithoutDoc(node *yaml.Node, comments map[string]ChartValueDescription, currentPath []string) []string {
	valuesWithoutDocs := make([]string, 0)
	switch node.Kind {
	case yaml.MappingNode:
		for i := 0; i < len(node.Content); i += 2 {
			keyNode, valueNode := node.Content[i], node.Content[i+1]
			currentPath = append(currentPath, keyNode.Value)
			pathString := strings.Join(currentPath, ".")
			if _, ok := comments[pathString]; !ok {
				valuesWithoutDocs = append(valuesWithoutDocs, pathString)
			}

childValuesWithoutDoc := collectValuesWithoutDoc(valueNode, comments, currentPath)
			valuesWithoutDocs = append(valuesWithoutDocs, childValuesWithoutDoc...)

currentPath = currentPath[:len(currentPath)-1]
		}
	case yaml.SequenceNode:
		for i := 0; i < len(node.Content); i++ {
			valueNode := node.Content[i]
			currentPath = append(currentPath, fmt.Sprintf("[%d]", i))
			childValuesWithoutDoc := collectValuesWithoutDoc(valueNode, comments, currentPath)
			valuesWithoutDocs = append(valuesWithoutDocs, childValuesWithoutDoc...)
			currentPath = currentPath[:len(currentPath)-1]
		}
	}
	return valuesWithoutDocs
}

func parseChartValuesFileComments(chartDirectory string, values *yaml.Node, lintingConfig ChartValuesDocumentationParsingConfig) (map[string]ChartValueDescription, error) {
	valuesPath := filepath.Join(chartDirectory, viper.GetString("values-file"))
	valuesFile, err := os.Open(valuesPath)

if isErrorInReadingNecessaryFile(valuesPath, err) {
		return map[string]ChartValueDescription{}, err
	}

defer valuesFile.Close()

keyToDescriptions := make(map[string]ChartValueDescription)
	scanner := bufio.NewScanner(valuesFile)
	foundValuesComment := false
	commentLines := make([]string, 0)
	currentLineIdx := -1

for scanner.Scan() {
		currentLineIdx++
		currentLine := scanner.Text()

// If we've not yet found a values comment with a key name, try and find one on each line
		if !foundValuesComment {
			match := valuesDescriptionRegex.FindStringSubmatch(currentLine)
			if len(match) < 3 || match[1] == "" {
				continue
			}
			foundValuesComment = true
			commentLines = append(commentLines, currentLine)
			continue
		}

// If we've already found a values comment, on the next line try and parse a custom default value. If we find one
		// that completes parsing for this key, add it to the list and reset to searching for a new key
		defaultCommentMatch := defaultValueRegex.FindStringSubmatch(currentLine)
		commentContinuationMatch := commentContinuationRegex.FindStringSubmatch(currentLine)

if len(defaultCommentMatch) > 1 || len(commentContinuationMatch) > 1 {
			commentLines = append(commentLines, currentLine)
			continue
		}

// If we haven't continued by this point, we didn't match any of the comment formats we want, so we need to add
		// the in progress value to the map, and reset to looking for a new key
		key, description := ParseComment(commentLines)
		keyToDescriptions[key] = description
		commentLines = make([]string, 0)
		foundValuesComment = false
	}
	if lintingConfig.StrictMode {
		err := checkDocumentation(values, keyToDescriptions, lintingConfig)
		if err != nil {
			return nil, err
		}
	}
	return keyToDescriptions, nil
}

func ParseChartInformation(chartDirectory string, documentationParsingConfig ChartValuesDocumentationParsingConfig) (ChartDocumentationInfo, error) {
	var chartDocInfo ChartDocumentationInfo
	var err error

chartDocInfo.ChartDirectory = chartDirectory
	chartDocInfo.ChartMeta, err = parseChartFile(chartDirectory)
	if err != nil {
		return chartDocInfo, err
	}

chartDocInfo.ChartRequirements, err = parseChartRequirementsFile(chartDirectory, chartDocInfo.ApiVersion)
	if err != nil {
		return chartDocInfo, err
	}

chartValues, err := parseChartValuesFile(chartDirectory)
	if err != nil {
		return chartDocInfo, err
	}

chartDocInfo.ChartValues = &chartValues
	chartDocInfo.ChartValuesDescriptions, err = parseChartValuesFileComments(chartDirectory, &chartValues, documentationParsingConfig)
	if err != nil {
		return chartDocInfo, err
	}

return chartDocInfo, nil
}
07070100000177000081A400000000000000000000000164C03CE400000CBE000000000000000000000000000000000000002D00000000helm-docs-1.11.1/pkg/helm/chart_info_test.gopackage helm_test

import (
	"github.com/norwoodj/helm-docs/pkg/helm"
	"github.com/spf13/viper"
	"github.com/stretchr/testify/suite"
	"os"
	"path/filepath"
	"regexp"
	"testing"
)

type ChartParsingTestSuite struct {
	suite.Suite
}

func (_ *ChartParsingTestSuite) SetupTest() {
	viper.Set("values-file", "values.yaml")
}

func (suite *ChartParsingTestSuite) resolveRelativePath(chartPath string) string {
	projectRoot := os.Getenv("PROJECT_ROOT")
	if projectRoot == "" {
		suite.T().Fatal("PROJECT_ROOT environment variable is not set")
	}
	return filepath.Join(projectRoot, chartPath)
}
func TestChartParsingTestSuite(t *testing.T) {
	suite.Run(t, new(ChartParsingTestSuite))
}

func (suite *ChartParsingTestSuite) TestNotFullyDocumentedChartStrictModeOff() {
	chartPath := suite.resolveRelativePath("example-charts/full-template/")
	_, err := helm.ParseChartInformation(chartPath, helm.ChartValuesDocumentationParsingConfig{
		StrictMode: false,
	})
	suite.NoError(err)
}

func (suite *ChartParsingTestSuite) TestNotFullyDocumentedChartStrictModeOn() {
	chartPath := suite.resolveRelativePath("example-charts/full-template/")
	_, err := helm.ParseChartInformation(chartPath, helm.ChartValuesDocumentationParsingConfig{
		StrictMode: true,
	})
	expectedError := `values without documentation: 
controller
controller.name
controller.image
controller.image.repository
controller.image.tag
controller.extraVolumes
controller.extraVolumes.[0].name
controller.extraVolumes.[0].configMap
controller.extraVolumes.[0].configMap.name
controller.publishService
controller.service
controller.service.annotations
controller.service.annotations.external-dns.alpha.kubernetes.io/hostname
controller.service.type`
	suite.EqualError(err, expectedError)
}

func (suite *ChartParsingTestSuite) TestNotFullyDocumentedChartStrictModeOnIgnores() {
	chartPath := suite.resolveRelativePath("example-charts/full-template/")
	_, err := helm.ParseChartInformation(chartPath, helm.ChartValuesDocumentationParsingConfig{
		StrictMode: true,
		AllowedMissingValuePaths: []string{
			"controller",
			"controller.image",
			"controller.name",
			"controller.image.repository",
			"controller.image.tag",
			"controller.extraVolumes",
			"controller.extraVolumes.[0].name",
			"controller.extraVolumes.[0].configMap",
			"controller.extraVolumes.[0].configMap.name",
			"controller.publishService",
			"controller.service",
			"controller.service.annotations",
			"controller.service.annotations.external-dns.alpha.kubernetes.io/hostname",
			"controller.service.type",
		},
	})
	suite.NoError(err)
}

func (suite *ChartParsingTestSuite) TestNotFullyDocumentedChartStrictModeOnIgnoresRegexp() {
	chartPath := suite.resolveRelativePath("example-charts/full-template/")
	_, err := helm.ParseChartInformation(chartPath, helm.ChartValuesDocumentationParsingConfig{
		StrictMode: true,
		AllowedMissingValueRegexps: []*regexp.Regexp{
			regexp.MustCompile("controller.*"),
		},
	})
	suite.NoError(err)
}

func (suite *ChartParsingTestSuite) TestFullyDocumentedChartStrictModeOn() {
	chartPath := suite.resolveRelativePath("example-charts/fully-documented/")
	_, err := helm.ParseChartInformation(chartPath, helm.ChartValuesDocumentationParsingConfig{
		StrictMode: true,
	})
	suite.NoError(err)
}
07070100000178000081A400000000000000000000000164C03CE40000079B000000000000000000000000000000000000002500000000helm-docs-1.11.1/pkg/helm/comment.gopackage helm

import (
	"strings"
)

const (
	PrefixComment = "# --"
)

func ParseComment(commentLines []string) (string, ChartValueDescription) {
	var valueKey string
	var c ChartValueDescription
	var docStartIdx int

// Work around https://github.com/norwoodj/helm-docs/issues/96 by considering only
	// the last "group" of comment lines starting with '# --'.
	lastIndex := 0
	for i, v := range commentLines {
		if strings.HasPrefix(v, PrefixComment) {
			lastIndex = i
		}
	}
	if lastIndex > 0 {
		// If there's a non-zero last index, consider that alone.
		return ParseComment(commentLines[lastIndex:])
	}

for i := range commentLines {
		match := valuesDescriptionRegex.FindStringSubmatch(commentLines[i])
		if len(match) < 3 {
			continue
		}

valueKey = match[1]
		c.Description = match[2]
		docStartIdx = i
		break
	}

valueTypeMatch := valueTypeRegex.FindStringSubmatch(c.Description)
	if len(valueTypeMatch) > 0 && valueTypeMatch[1] != "" {
		c.ValueType = valueTypeMatch[1]
		c.Description = valueTypeMatch[2]
	}

var isRaw = false

for _, line := range commentLines[docStartIdx+1:] {
		rawFlagMatch := rawDescriptionRegex.FindStringSubmatch(line)
		defaultCommentMatch := defaultValueRegex.FindStringSubmatch(line)
		notationTypeCommentMatch := valueNotationTypeRegex.FindStringSubmatch(line)

if !isRaw && len(rawFlagMatch) == 1 {
			isRaw = true
			continue
		}

if len(defaultCommentMatch) > 1 {
			c.Default = defaultCommentMatch[1]
			continue
		}

if len(notationTypeCommentMatch) > 1 {
			c.NotationType = notationTypeCommentMatch[1]
			continue
		}

commentContinuationMatch := commentContinuationRegex.FindStringSubmatch(line)

if isRaw {

if len(commentContinuationMatch) > 1 {
				c.Description += "\n" + commentContinuationMatch[2]
			}
			continue
		} else {
			if len(commentContinuationMatch) > 1 {
				c.Description += " " + commentContinuationMatch[2]
			}
			continue
		}
	}
	return valueKey, c
}
07070100000179000041ED00000000000000000000000264C03CE400000000000000000000000000000000000000000000001A00000000helm-docs-1.11.1/pkg/util0707010000017A000081A400000000000000000000000164C03CE4000000E2000000000000000000000000000000000000002200000000helm-docs-1.11.1/pkg/util/file.gopackage util

import "path"

func IsRelativePath(filePath string) bool {
	return (filePath[0] == '.') && path.Base(filePath) != filePath
}

func IsBaseFilename(filePath string) bool {
	return path.Base(filePath) == filePath
}
0707010000017B000081A400000000000000000000000164C03CE400000100000000000000000000000000000000000000002100000000helm-docs-1.11.1/pkg/util/git.gopackage util

import (
	"os/exec"
	"strings"
)

func FindGitRepositoryRoot() (string, error) {
	path, err := exec.Command("git", "rev-parse", "--show-toplevel").Output()

if err != nil {
		return "", err
	}

return strings.TrimSpace(string(path)), nil
}
0707010000017C000081A400000000000000000000000164C03CE400000876000000000000000000000000000000000000002400000000helm-docs-1.11.1/pkg/util/ignore.gopackage util

import (
	"bufio"
	"fmt"
	"os"
	"path/filepath"

log "github.com/sirupsen/logrus"
	"k8s.io/helm/pkg/ignore"
)

var defaultIgnore = map[string]bool{
	".git": true,
}

type IgnoreContext struct {
	rules       *ignore.Rules
	relativeDir string
}

func parseIgnoreFilePathToRules(filename string) (*ignore.Rules, error) {
	ignoreFile, err := os.Open(filename)

if os.IsNotExist(err) {
		log.Debugf("No ignore file found at %s, using empty ignore rules", filename)
		return ignore.Empty(), nil
	}

if err != nil {
		return nil, fmt.Errorf("failed to open ignore file at %s: %s", filename, err)
	}

ignoreRules, err := ignore.Parse(bufio.NewReader(ignoreFile))
	if err != nil {
		return nil, fmt.Errorf("failed to parse ignore rules from file %s: %s", filename, err)
	}

log.Debugf("Found ignore file at %s, using those ignore rules", filename)
	return ignoreRules, nil
}

func NewIgnoreContext(ignoreFilename string) IgnoreContext {
	gitRepositoryRoot, err := FindGitRepositoryRoot()

// If we got an error reading the repository root, then let's try for a ignore file in this directory
	if err != nil {
		ignoreRules, err := parseIgnoreFilePathToRules(ignoreFilename)

if err != nil {
			log.Warnf("Using empty ignore rules due to error: %s", err)
			return IgnoreContext{rules: ignore.Empty()}
		}

absoluteWorkingDir, _ := filepath.Abs(".")
		return IgnoreContext{rules: ignoreRules, relativeDir: absoluteWorkingDir}
	}

// Otherwise, let's look for a ignore file at the repository root and parse it, storing that files are ignored relative
	// to that directory
	ignoreRules, err := parseIgnoreFilePathToRules(filepath.Join(gitRepositoryRoot, ignoreFilename))

if err != nil {
		log.Warnf("Using empty ignore rules due to error: %s", err)
		return IgnoreContext{rules: ignore.Empty()}
	}

return IgnoreContext{rules: ignoreRules, relativeDir: gitRepositoryRoot}
}

func (i IgnoreContext) ShouldIgnore(path string, fi os.FileInfo) bool {
	pathRelativeToIgnoreFile, err := filepath.Rel(i.relativeDir, path)

if err != nil {
		return false
	}

return i.rules.Ignore(pathRelativeToIgnoreFile, fi) || defaultIgnore[pathRelativeToIgnoreFile]
}
07070100000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000B00000000TRAILER!!!900 blocks

Places

File helm-docs-1.11.1.obscpio of Package helm-docs (Revision b3f3c3e9c69620f1de4009d12cdfa24e)

Places