Skip to content

Automatic helm doc generation #340

@Isan-Rivkin

Description

@Isan-Rivkin
  • Known helm-docs plugin to generate docs:
  • We can automate the doc generation in an action or something but at first we can just pre-commit hook. The hook can be added by each dev. We can then add an action to simply check if values.yaml has changed while README.md didn't fail and request to run helm-docs locally and commit again.

Flow:

  1. Dev changes locally values.yaml
  2. Dev runs locally make helm-docs > docs are generated
  3. Commit and push
  4. CI verifies if values.yaml changed then README.md changes.
  5. Merge

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions